-
安装Doxygen
sudo apt-get install doxygen -
安装Graphviz
sudo apt-get install graphviz -
doxygen -g
或者，doxygen –s –g （simple，generate）
使用上述命令在当前目录下生成名为Doxygen的配置文件模板；默认生成的配置文件名为 Doxyfile
1）在配置文件中修改PROJECT_NAME; PROJECT_NUMBER;
OUTPUT_DIRECTORY(输出文档的目录，如果为空，表示在当前目录)； OUTPUT_LANGUAGE（可以指定为Chinese）；IMAGE_PATH = image_dir（指定图片存放的目录，将图片放到当前目录下的image_dir）
INPUT =xxx，代码文件或目录，多个文件(目录)需要以空格隔开，如果不指定，表示当前目录；如果指定目录且当前目录有代码文件的话，需要用(.)表示当前目录
FILE_PATTERNS = *.cpp *.h
doxygen Doxyfile //可以生成一个文档
- c系语言中的注释块
1）详细注释
///
/// ... text ...
///
或者
/**
- ... text ...
/ 等方式。。。
如果想让注释块更可见，可用下面方式：
/*********************************//* - ... text
*************************************/
或者
//////////////////////////////////////////////////////
/// ... text ...
/////////////////////////////////////////////////////
2）简单注释
/// Brief description.
- 文本放在成员后面
当要给文件的成员，结构体，类，枚举添加文本，需要将文本块放到成员后面。加上<在评论块中，这同样可以作用于函数的参数
int var; ///< detailed description after the member
对于函数要使用[in,out]
void foo(int v /*< [in] docs for input parameter v. /);
以上4-5只可以用于注释成员（members）和参数（parameters）
%%%
变量注释
/// 简述
/ 详细描述 */ - Doxygen中需要改的地方
1）DOXYFILE_ENCODING = UTF-8
2）PROJECT_NAME 项目名称
3）PROJECT_NUMBER 项目版本号
4）OUTPUT_DIRECTORY 输出文档的目录，建议写上表示本工程的有意义的目录名称
5）OUTPUT_LANGUAGE = English，文档语言，可以指定为Chinese
6）IMAGE_PATH = image_dir，指定图片存放的目录，我们将图片放到当前目录下的image_dir目录中，因为我们的文档会出现测试图片示例
7）HTML_OUTPUT= . ，html输出目录名称，默认为html目录，如果为“.”则表明为上述OUTPUT_DIRECTORY目录
8）INPUT =xxx，代码文件或目录，多个文件(目录)需要以空格隔开，如果不指定，表示当前目录，但是，如果指定目录且当前目录有代码文件的话，需要使用点号(“.”)表示当前目录
9）FILE_PATTERNS=xxx，指定各种文件，我们常用为*.cpp *.c *.h，等等 - \class 注释类
\struct \union \enum \fn注释函数 \var 变量或者类型或者枚举值 \def 注释#define \typedef document a type definition \file 注释一个文件 \namespace 注释命名空间 \package 注释java程序包 \interface 注释一个IDL界面
%%配置选项参考连接
http://blog.51cto.com/ticktick/188672
网友评论