安装doxygen（一个自动文档生成工具）

Posted 2020-09-12

由于你电脑里可能还没有doxygen，我们先来安装一下：

sudo apt-get install doxygen doxygen-gui

[sudo] password for wj: 
Reading package lists... Done
Building dependency tree       
Reading state information... Done
The following package was automatically installed and is no longer required:
  libopencc1
Use ‘apt-get autoremove‘ to remove it.
Suggested packages:
  doxygen-doc
The following NEW packages will be installed:
  doxygen-gui
0 upgraded, 1 newly installed, 0 to remove and 354 not upgraded.
Need to get 279 kB of archives.
After this operation, 671 kB of additional disk space will be used.
Get:1 http://cn.archive.ubuntu.com/ubuntu/ trusty/universe doxygen-gui amd64 1.8.6-2 [279 kB]
Fetched 279 kB in 0s (291 kB/s)      
Selecting previously unselected package doxygen-gui.
(Reading database ... 264559 files and directories currently installed.)
Preparing to unpack .../doxygen-gui_1.8.6-2_amd64.deb ...
Unpacking doxygen-gui (1.8.6-2) ...
Processing triggers for man-db (2.6.7.1-1ubuntu1) ...
Setting up doxygen-gui (1.8.6-2) ...

总之，主要是doxygen本体和它的gui模块。如果你不确定，请用这个查一下。

apt-cache search doxygen-gui

 

拿以难读著称的lsd-slam举个例子。

[1]首先，建个文件夹，把lsd-slam的代码拷下来：

git clone https://github.com/tum-vision/lsd_slam.git

[2]在该文件夹下开一个doc文件夹，把一会儿生成的文档放里头：

mkdir doc;
 cd doc

[3]输入doxywizard调出gui面板。

[email protected]:~/Downloads/lsd_slam/doc$ doxywizard

然后就会出一个面板啦...

我填写的： 1.[1]Step 1中的目录设到你要保存文档的目录。

[2]Project name那些东西随意，可以不设。

[3]重要的是源代码目录source code directory，请把它设到lsd_slam_core/src下，并钩上Scan recursively，表明我们要扫描子文件夹。

[4]输出文件夹设成当前目录./即可,也就是/home/wj/Downloads/lsd_slam/doc

 2.进入下一个版块,点左边的“Mode”。下个版块里会让你选语言，既然咱们用c++，保持默认的就可以了。

3.Output和Diagrams也没什么好动的。

4.准备工作完成啦！切到Run，点“Run doxygen"，等文档生成完。然后点“show html output"，就可以在浏览器里看到文档啦。如果你下一次想直接看，直接打开doc/html/index.html就可以了！

{详细的可以参考：http://www.cnblogs.com/chenyang920/p/5732643.html}

看这个比看源代码效果更高哦！

 

命令行

　　doxygen本身是命令行格式的，给一个配置文件，然后根据配置文件去生成文档。但是！几百个配置选项我怎么记得住啊！既然图形界面那么好用为啥要去用命令行啊！如果没有桌面环境？那还是乖乖用命令行吧……

　　命令行的doxygen也很简单。首先用

1 doxygen -s -g settings.txt

 　　生成一个配置文件，然后去修改配置文件里的值，基本上和上面讲的差不多啦！只是配置会复杂一点。比较重要的参数有输入，输出，扫描文件的后缀名等等。其实这些都可以在图形界面的“Expert“里配的！我也是这么干的！所以如果你有屏幕的话还是建议你用图形界面啦！当这个文件改好后，调用

doxygen settings.txt

 　　按这个文件生成文档。当然如果你写错了，文档就不会生成了！所以还是用图形界面吧！