g2o通过doxygen生成代码解释文件

这几天在使用g2o但是官网没有给出详细的api函数，笔者去github上查找依旧没有找到。但是在源码中的doc文件中居然有个doxy.config和readme.txt。笔者打开readme发现可以使用doxygen生成api函数的解释！！！！

1、介绍

        这里就简单和大家介绍一下这个工具，这个工具08年就已经存在了。这是一个自动生成文档工具。如果你查看过opencv的api文档介绍你应该很熟悉。这个工具就是通过注释自动生成html和latex格式的文档。通常都是给C++使用的，如果你下载一份开源代码并且里面有一定量的注释，你就可以使用改工具生成opencv一样的函数介绍文档了，妈妈再也不担心我看不懂代码了！！！

2、g2o生成函数介绍文档

        使用g2o都知道，官方只给出了pdf里面的例子也只有几个。大量的api函数不明白什么意思，官方其实早有准备。在你安装的g2o目录下（你的路径）/g20/doc/doxygen下先看readme.

run the following in the current folder

doxygen doxy.config

assumes that dot tool is installed and available from path

        我们只需要run doxy.config这个文件会自动生成函数介绍文档。但是不是简单把他设置为可执行文件我们需要借助doxygen运行。

        1、安装

sudo apt-get install doxygen doxygen-gui

推荐大家使用gui版本，也没必要专门去学习它的命令，本身就是学习工具直接使用gui快捷生成。

我们只需要在任意终端输入就会调用gui面板：

doxywizard

以下图片就是打开后的效果               

 

 接下来很简单，只需要点击file->open 打开你g2o的doxy.config，之后我们可以看见面板上有个run按钮，点击Run doxygen等待一下，g2o函数还是挺多的耐心等待。之后完成点击show HTML output 就会自动弹出函数介绍网页！！

 是不是和opencv网站的介绍文档很相似。

3、使用其他代码生成

        首先把Step 1中的目录设到你要保存文档的目录。Project name那些东西随意，可以不设。比较重要的是源代码目录source code directory，请把它设到（你下载的代码）/src下，并钩上Scan recursively，表明我们要扫描子文件夹。然后，输出文件夹设成当前目录./即可，本来我们就在当前目录嘛。其他啥的可以不用动，之后就和生成g2o方法一样就可以生成同样的api函数介绍了！！！

参考：

SLAM拾萃(2)：doxygen - 半闲居士 - 博客园