Doxygen 使用 和配置

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接: https://blog.csdn.net/qq_41204464/article/details/102457597

目录

一、默认配置生成

二、自定义配置生成(推荐)

1)项目基础设置

2)Expert设置

2.1 Project

2.2 Build

2.3 input

2.4 Source Browser​

2.5 HTML

2.6 Dot

3 Run 点击运行即可


一、默认配置生成

选择要生成说明文档的代码,其所在的目录

使用默认配置生成:

查看生成的输出结果:

可以看到浏览器中,出现相关的说明文档:

二、自定义配置生成(推荐)

1)项目基础设置

2)Expert设置

2.1 Project

每个配置项均有详细鼠标放置时均有详细注释,以下是我的设置可供参考,特别注意语言,避免中文乱码

 

2.2 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 :是否显示文件列表页面,如果开启,那么帮助中会存在一个一个文件列表索引页面。

2.3 input



2.4 Source Browser

2.5 HTML

2.6 Dot


3 Run 点击运行即可

生成文件在工程 

查看生成文档目录,有html,latex

latex目录下:

希望对你有帮助。 

猜你喜欢

转载自blog.csdn.net/qq_41204464/article/details/102457597