C++工程 API文档生成-doxygen

参考如下博文:


http://blog.sina.com.cn/s/blog_6294abe701012pee.html

其中有对doxgen的基本配置项作用的描述。

一、从http://www.doxygen.nl/download.html 下载Windows 二进制安装包并安装。

点击GIT binaries 下的 Windows binaries链接进入到具体下载页。再点击Download doxygen-****-setup.exe,下载完后安装。

C++工程 API文档生成-doxygen_第1张图片

二、安装完毕之后,进行配置。

1.确保Step1中的输出目录设置正确

C++工程 API文档生成-doxygen_第2张图片

2.点击Expert页,确保Step2的其他详细配置正确。即Expert各子页面中红色字体部分。

2.1Project

C++工程 API文档生成-doxygen_第3张图片
2.2Message
C++工程 API文档生成-doxygen_第4张图片
2.3 Input
C++工程 API文档生成-doxygen_第5张图片
2.4.Source Browser
C++工程 API文档生成-doxygen_第6张图片
2.5 Dot
C++工程 API文档生成-doxygen_第7张图片
三、点击Run页,再点击 Run doxygen,即可生成C++工程的API描述文档了。
效果如下:
C++工程 API文档生成-doxygen_第8张图片
注意点:
1.有时候文件放在不同层级的文件夹,会解析不了,这个时候再Input页,将各个子目录添加到INPUT一栏中即可
2.output路径最好设置在Android工程的根目录下,这样在eclipse中刷新就能将输出的html文件加载到工程中,浏览检索和工程拷贝的时候会很方便


你可能感兴趣的:(工作辅助知识)