Doxygen 使用教程小结

版权声明:本文为博主原创文章,未经博主同意不可随意转载。 https://blog.csdn.net/hellokandy/article/details/85095461

【安装】

1、安装Doxygen

下载地址:http://www.doxygen.nl/download.html

2、安装Graphviz

下载地址:http://www.graphviz.org/download/

graphviz 是一个由AT&T实验室启动的开源工具包,用于绘制DOT语言脚本描述的图形。Doxygen 使用 graphviz 自动生成类之间和文件之间的调用关系图,如不需要此功能可不安装该工具包。

3、安装 Windows Help Workshop

下载地址:https://docs.microsoft.com/zh-cn/previous-versions/windows/desktop/htmlhelp/microsoft-html-help-downloads

Doxygen 使用这个工具可以生成 CHM 格式的文档。

【配置】

1、程序代码中的注释符合doxygen风格。

2、使用Doxywizard进行配置

3、使用Doxygen来产生批注文档


以下是doxywizard的详细配置图文教程:

说明:1,Doxygen 工作目录,就是用来存放配置文件的目录。4,递归搜索源文件目录需要选上。

Wizard 标签下的 Output

doxygen本身不支持直接生成pdf文件,而是提供生成pdf需要的原材料(latex),然后再使用CTeX (下载CTeX :https://mirrors.tuna.tsinghua.edu.cn/ctex/legacy/2.9/)将latex生成PDF。

生成PDF
(1)CTeX安装完成后打开Texworks软件,再打开latex/refman.tex
(2)在“排版”选项中选择pdfLaTex+MakeIndex+BibTex,最后点击左上角“排版”,即可生成refman.pdf。
 

Wizard 下的 Diagrams

说明:如果选择这个选项之前需要先安装了 Graphviz 工具包。

 

Expert 标签下的 Project

说明:编码格式,UTF-8 是首选。如果需要显示中文则选择GB2312

 

Expert 标签下的 Build

Build页面,这个页面是生成帮助信息中比较关键的配置页面:

EXTRACT_ALL 输出所有的函数,但是private和static函数不属于其管制。
EXTRACT_PRIVATE 输出private函数。
EXTRACT_STATIC 输出static函数。同时还有几个EXTRACT,相应查看文档即可。
HIDE_UNDOC_MEMBERS 那些没有使用doxygen格式描述的文档(函数或类等)就不显示了。当然,如果EXTRACT_ALL被启用,那么这个标志其实是被忽略的。
INTERNAL_DOCS 是否输出注解中的@internal部分。如果没有被启动,那么注解中所有的@internal部分都将在目标帮助中不可见。
CASE_SENSE_NAMES 是否关注大小写名称,注意,如果开启了,那么所有的名称都将被小写。对于C/C++这种字母相关的语言来说,建议永远不要开启。
HIDE_SCOPE_NAMES 域隐藏,建议永远不要开启。
SHOW_INCLUDE_FILES 是否显示包含文件,如果开启,帮助中会专门生成一个页面,里面包含所有包含文件的列表。
INLINE_INFO 如果开启,那么在帮助文档中,inline函数前面会有一个inline修饰词来标明。
SORT_MEMBER_DOCS 如果开启,那么在帮助文档列表显示的时候,函数名称会排序,否则按照解释的顺序显示。
GENERATE_TODOLIST 是否生成TODOLIST页面,如果开启,那么包含在@todo注解中的内容将会单独生成并显示在一个页面中,其他的GENERATE选项同。
SHOW_USED_FILES 是否在函数或类等的帮助中,最下面显示函数或类的来源文件。
SHOW_FILES 是否显示文件列表页面,如果开启,那么帮助中会存在一个一个文件列表索引页面。

 

Expert 标签下的 Input

说明:输入的源文件的编码,要与源文件的编码格式相同。如果源文件不是UTF-8编码最好转一下。

 

expert 标签下的 HTML

说明:

1,CHM_FILE文件名需要加上后缀(xx.chm)。

2,如果在 Wizard 的 Output Topics 中选择了 prepare for compressed HTML (.chm)选项,此处就会要求选择 hhc.exe 程序的位置。在 windows help workshop 安装目录下可以找到 hhc.exe。

3,为了解决DoxyGen生成的CHM文件的左边树目录的中文变成了乱码,CHM_INDEX_ENCODING 中输入GB2312即可。

4,GENERATE_CHI 表示索引文件是否单独输出,建议关闭。否则每次生成两个文件,比较麻烦。

5,TOC_EXPAND 表示是否在索引中列举成员名称以及分组(譬如函数,枚举)名称。

 

选择 Run 标签

 

猜你喜欢

转载自blog.csdn.net/hellokandy/article/details/85095461