Doxygen的个人使用心得和记录

由于工作原因，使用了Doxygen工具来生成一些相关文档。以下是使用记录

 

1 生成配置文件：

doxygen –g xxx.docx

2 编辑配置文件

后面说明

3 生成文档： doxygen  xxx.docx

4 其中编译配置文件是里面比较麻烦的工作，我的配置记录如下：

PROJECT_LOGO           = ./doc_logo.jpeg  // 这个会Copy到Html的生成目录中去，效果是首页左上角有个你自定义的图标，这个对于图片大小有需求

OUTPUT_LANGUAGE        = Chinese

EXTRACT_ALL            = YES // 解析所有成员

EXTRACT_PRIVATE        = YES // 这个其实应该包含于上面的

GENERATE_TODOLIST      = YES // 这个可以解析 @todo相关的注释

GENERATE_BUGLIST       = YES

GENERATE_DEPRECATEDLIST= YES

SHOW_FILES             = YES

SHOW_NAMESPACES        = YES

FILE_PATTERNS          =  *.h .... // 将你需要解析的文件放到里面

FILE_PATTERNS          = *.qml \
                         *.h \
                         *.cpp \
                         *.js \
                         *.dox

RECURSIVE              = YES

FILTER_PATTERNS        = *.qml=/usr/local/bin/doxyqml

INCLUDE_FILE_PATTERNS  = *.cpp \
                         *.h \
                         *.qml \
                         *.js

CLASS_GRAPH            = YES

COLLABORATION_GRAPH    = YES

GROUP_GRAPHS           = YES

UML_LOOK               = YES

INCLUDE_GRAPH          = YES

INCLUDED_BY_GRAPH      = YES

CALL_GRAPH             = YES

CALLER_GRAPH           = YES

GRAPHICAL_HIERARCHY    = YES

DIRECTORY_GRAPH        = YES

DOT_IMAGE_FORMAT       = png

DOT_MULTI_TARGETS      = YES

GENERATE_LEGEND        = YES

DOT_CLEANUP            = YES

以上的效果是生成一些带有UML图的文档，但是前提条件是安装 Graphviz 

5 生成PDF文档，但是貌似有中文的话就会出现一些问题

在生成后的Latex中执行make来生成PDF文档

6 首页的自定义一个文件mainpage.dox，一个功能只能有一个

//!\mainpage caption
//! AAAAA

7 如何定义首页需要显示的自定义图片？

//!\mainpage caption
//!AAAA:
//!\image html ./whole.png "caption" <size>

这个SIZE我没搞懂，但是可以显示自定义图片，唯一要注意的是要把这写文件copy到html下，或者写成绝对目录