Zeal是Dash的开源版本,用于文档搜索和查看.
1.安装
安装很简单: (ubuntu 14.04)
sudo apt-add-repository ppa:zeal-developers/ppa
sudo apt-get update
sudo apt-get install zeal
2.启动
控制台输入
zeal
之后发现无法使用,看不到 Edit 这个菜单。所以:
$ sudo apt-get remove appmenu-qt5 ( refer to: https://github.com/zealdocs/zeal/issues/134 )
然后就可以 zeal 了
3.下载可用文档
然后, 选择 Tools > Docsets > Available
下载个opencv文档
如图在左边搜索API函数
4.ros离线文档下载
通过ROS进行机器人开发设计,需要查阅C++或Python等文档,也需要时常翻阅ROS wiki和GitHub。使用zeal查看更加方便.
1.方法1:
选择 Tools > Docsets >Installed
再选择add feed
输入
https://raw.githubusercontent.com/famalgosner/ros.org.docset/master/ROS.xml
确定,半天没有安装...
2方法2
用下面链接直接下载
https://github.com/famalgosner/ros.org.docset/releases/download/0.0.3/ROS.tgz
ros的docset文件
然后解压拷贝ROS.docset文件到
~/.local/share/Zeal/Zeal/docsets
文件夹下
如图
有些文档zeal源没有,那么自己下的离线文档怎么打开呢?
方法是使用doxygen生成离线文档,然后用zeal查看,请看下文:
比如ros包就可以用doxygen生成离线文档,然后用zeal打开,就能够离线搜索api啦!
5使用doxygen生成离线文档
5.1 ubantu14 doxygen安装
sudo apt-get install doxygen
Doxygen是一款文档生成工具,它可以从代码中提取出相应的文档,并组织,输出成各种漂亮的文档(如HTML,PDF,RTF等)
有了Doxygen工具,程序员便可以在写代码的时候,直接内嵌文档,再也不需要为某个功能代码单独写文档,从而最大程度的保持了文档和代码的统一性.
5.2 Doxygen使用
参考http://cedar-renjun.github.io/2014/03/21/learn-doxygen-in-10-minutes/index.html
先来个Doxygen 生成文档的例子
如下步骤:
mkdir hello
cd hello
vi main.cpp
编辑main.cpp
#include <iostream>
using namespace std;
int main()
{
cout << "Hello World!" << endl;
return 0;
}
在hello文件夹输入
doxygen -g
发现当前文件夹下生成了Doxyfile
输入
doxygen ./Doxyfile
发现生成了latex 和html文件夹
cd html
firefox index.html
可以在html文件夹打开index.html文件就是生成的离线文档
6.转换doxygen生成的离线文档为zeal能打开的docset文件
1.编辑Doxyfile文件改为
GENERATE_DOCSET = YES
DISABLE_INDEX = YES
SEARCHENGINE = NO
GENERATE_TREEVIEW = NO
2.参考https://github.com/famalgosner/ros.org.docset/
中的readme.txt生成docset
make 出现
make: /usr/bin/docsetutil:命令未找到
错误,没有解决
希望有人能找到解决方法
参考
https://blog.csdn.net/u011008029/article/details/65437537
http://ju.outofmemory.cn/entry/184797
https://blog.csdn.net/wenqing_02/article/details/53189745
https://kapeli.com/docsets