doxygen是一个自动文档生成工具,根据代码里写的注释,自动生成html和latex格式的文档。通常是给c++用的,通常是出html格式的,你看到的pcl网上文档就是拿doxygen生成的。
事实上,随意一份代码,都可以拿doxygen生成一个文档,然后在本地看它的代码结构。 我们拿以难读著称的lsd-slam举个例子。
由于你电脑里可能还没有doxygen,我们先来安装一下:
sudo apt-get install doxygen doxygen-gui【主要是doxygen本体和它的gui模块。我在ubuntu14.04下是这两个包名。如果你不确定,请用apt-cache search doxygen查一下。】
在该文件夹下开一个doc文件夹,把一会儿生成的文档放里头:
mkdir doc
cd doc
doxywizard【调出gui面板】
首先,建个文件夹,把lsd-slam的代码拷下来:
git clone https://github.com/tum-vision/lsd_slam.git
切到Run,点“Run doxygen",等文档生成完。然后点“show html output",就可以在浏览器里看到文档啦。如果你下一次想直接看,直接打开doc/html/index.html就可以了!
参考 半闲居士博客,非常感谢。
网友评论