#doxygen# 生成文档无成员变量

本文详细介绍Doxygen配置选项,包括如何生成文档、解析私有成员、处理文件和目录、生成不同格式文档等,帮助读者掌握Doxygen使用技巧。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

这是一个生成文档的工具,可以通过代码文件中的注释进行文档的生成,通过画图工具可以绘制调用过程和文件包含关系等。

然后在使用过程中,可能会发现生成文档无成员变量。

这是因为doxygen对私有成员未导出,按以下配置即可。

 

 doxygen配置选项含义详解

选项含义
DOXYFILE_ENCODINGDoxygen文件的编码方式,默认为UTF-8,若希望支持中文,最好设置为 GB2312
PROJECT_NAMEProject 的名字,以一个单词为主,多个单词请使用双引号括住。
PROJECT_VERSIONProject的版本号码。
OUTPUT_DIRECTORY输出路径。产生的文件会放在这个路径之下。如果没有填这个路径,将会以目前所在路径作为输出路径。
OUTPUT_LANGUAGE输出语言, 默认为English 。
EXTRACT_ALL为NO,只解释有doxygen格式注释的代码;为YES,解析所有代码,即使没有注释
EXTRACT_PRIVATE是否解析类的私有成员
EXTRACT_STATIC是否解析静态项
EXTRACT_LOCAL_CLASSES是否解析源文件(cpp文件)中定义的类
INPUT指定加载或找寻要处理的程序代码文件路径。这边是一个表列式的型态。并且可指定档案及路径。
FILE_PATTERNS如果您的INPUT Tag 中指定了目录。您可以透过这个Tag来要求Doxygen在处理时,只针对特定的档案进行动作。例如:您希望对目录下的扩展名为.c, .cpp及.h的档案作处理。您可设定FILE_PATTERNS = .c, .cpp, *.h。
RECURSIVE这是一个布尔值的Tag,只接受YES或NO。当设定为YES时,INPUT所指定目录的所有子目录都会被处理.
EXCLUDE如果您有某几个特定档案或是目录,不希望经过Doxygen处理。您可在这个Tag中指定。
EXCLUDE_PATTERNS类似于FILE_PATTERNS的用法,只是这个Tag是供EXCLUDE所使用。
SOURCE_BROWSER如果设定为YES,则Doxygen会产生出源文件的列表,以供查阅。
INLINE_SOURCES如果设定为YES ,则函数和类的实现代码被包含在文档中
ALPHABETICAL_INDEX如果设定为YES,则一个依照字母排序的列表会加入在产生的文件中。(有很多类、结构等项时建议设为YES)
GENERATE_HTML若设定为YES ,就会产生HTML版本的说明文件。HTML文件是Doxygen预设产生的格式之一。
HTML_OUTPUTHTML文件的输出目录。这是一个相对路径,所以实际的路径为OUTPUT_DIRECTORY加上HTML_OUTPUT。这个设定预设为html。
GENERATE_HTMLHELP是否生成压缩HTML格式文档(.chm)
HTML_FILE_EXTENSIONHTML文件的扩展名。预设为.html。
HTML_HEADER要使用在每一页HTML文件中的Header。如果没有指定,Doxygen会使用自己预设的Header。
HTML_FOOTER要使用在每一页HTML文件中的Footer。如果没有指定,Doxygen会使用自己预设的Footer。
HTML_STYLESHEET您可给定一个CSS 的设定,让HTML的输出结果更完美。
GENERATE_HTMLHELP如设定为YES,Doxygen会产生一个索引文件。这个索引文件在您需要制作windows 上的HTML格式的HELP档案时会用的上。
GENERATE_TREEVIEW若设定为YES,Doxygen会帮您产生一个树状结构,在画面左侧。这个树状结构是以JavaScript所写成。所以需要新版的Browser才能正确显示。
TREEVIEW_WIDTH用来设定树状结构在画面上的宽度。
GENERATE_LATEX设定为YES 时,会产生LaTeX 的文件。不过您的系统必需要有安装LaTeX 的相关工具。
LATEX_OUTPUTLaTeX文件的输出目录,与HTML_OUTPUT用法相同,一样是指在OUTPUT_DIRECTORY之下的路径。预设为latex。
LATEX_CMD_NAMELaTeX程序的命令名称及档案所在。预设为latex。
GENERATE_RTF若设定为YES ,则会产生RTF 格式的说明档。
RTF_OUTPUT与HTML_OUTPUT 用法相同,用来指定RTF 输出档案路径。预设为rtf。
GENERATE_MAN若设定为YES ,则会产生Unix Man Page 格式的说明文件。
MAN_OUTPUT与HTML_OUTPUT 用法相同,用来指定Man Page的输出目录。预设为man。
GENERATE_XML若设定为YES ,则会产生XML 格式的说明文件。
ENABLE_PREPROCESSING若设定为YES ,则Doxygen 会激活C 的前置处理器来处理原始档。
PREDEFINED可以让您自行定义一些宏。类似于gcc 中的-D选项。
CLASS_DIAGRAMS这个标记用来生成类继承层次结构图。要想生成更好的视图,可以从 Graphviz 下载站点 下载 dot 工具。Doxyfile 中的以下标记用来生成图表:
HAVE_DOT如果这个标记设置为 Yes,doxygen 就使用 dot 工具生成更强大的图形,比如帮助理解类成员及其数据结构的协作图。注意,如果这个标记设置为 Yes, 标记就无效了
CLASS_GRAPH如果  标记和这个标记同时设置为 Yes,就使用 dot 生成继承层次结构图
GRAPHICAL_HIERARCHY设置为YES时,将会绘制一个图形表示的类图结构
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值