要写API,所以用Doxygen来进行文档生成。本文记录命令行版(非GUI)Doxygen从无到有配置和使用的过程。
使用方法:
1 安装doxygen:可以apt,也可以源码,也可以预编译的binary。
2 使用docygen。它主要分2个步骤:
- 产生一个配置文件,规定输入、输出样式
- 对输入文件按他的语法进行注释,从而生成对应文档。
步骤:
- 首先
cd
到项目根目录,然后
doxygen -g
这会产生在当前目录下产生一个叫Doxygen
的配置文件,根据需要修改该配置文件。
- 修改配置文件。
一般要改的有这些:
PROJECT_NAME
PROJECT_NUMBER
INPUT
GENERATE_LATEX
EXTRACT_ALL
EXTRACT_STATIC
EXTRACT_PRIVATE
GENERATE_TREEVIEW
USE_MDFILE_AS_MAINPAGE
-> 如果有值,这个时候要准备一个markdown文件来描述 - 按要求注释文档
- 对整个函数在上方或内部注释:
/**
* <comment>
*/
- 同行代码注释:
/// <comment>
其中comment可以有这些:
1. @brief
2. remark
3. @param
4. @return
5. @note
如果不想要所有函数都出现,那么在设定EXTRACT_PRIVATE=NO
的前提下,在想要隐藏的函数里打上
/// @private
即可。