生成配置文件
在工程根目录下输入命令
doxygen -g <文档名>
例如
doxygen -g LinkedList
修改配置文件
结构为 <TAGNAME>
= <VALUE>
,如果有多个值,则为 <TAGNAME>
= <VALUE>
<VALUE>
。
基础配置项
文档存放的相对目录 (line: 61)
OUTPUT_DIRECTORY = documentation
需要包含的源文件相对目录 (line: 794)
INPUT = src
工程名 (line: 35)
PROJECT_NAME = "链表"
可选配置项:
文件扩展名 (line: 819)
FILE_PATTERNS = *.c \
*.cc \
*.cxx \
*.cpp \
*.c++ \
*.java \
*.ii \
*.ixx \
*.ipp \
*.i++ \
*.inl \
*.idl \
*.ddl \
*.odl \
*.h \
*.hh \
*.hxx \
*.hpp \
*.h++ \
*.cs \
*.d \
*.php \
*.php4 \
*.php5 \
*.phtml \
*.inc \
*.m \
*.markdown \
*.md \
*.mm \
*.dox \
*.py \
*.pyw \
*.f90 \
*.f95 \
*.f03 \
*.f08 \
*.f \
*.for \
*.tcl \
*.vhd \
*.vhdl \
*.ucf \
*.qsf
递归搜索(即有子目录时,会搜索子目录)(line: 868)
RECURSIVE = YES
没有文档也要提取信息 (line: 439)
EXTRACT_ALL = YES
包含私有数据成员(line: 445)
EXTRACT_PRIVATE = YES
包含静态成员,包括函数和变量 (line: 457)
EXTRACT_STATIC = YES
生成最终文档
在工程根目录下输入命令
doxygen <文档名>
例如
doxygen LinkedList
注:仔细观察输出的信息,修改可能存在的 warning
添加主页
以添加markdown文本为例
- 在工程根目录添加
mainpage.md
文件 - 打开mainpage.md,首行的格式为
@mainpage 参考手册
markdown格式内容
- 在配置文件中,
INPUT
添加mainpage.md
- 重新生成文档
本文为原创文章,转载请注明出处: https://www.liuguogy.com/archives/doxygen-generate-reference.html
你的文章缩略图哪里找的!??
这个网站可以找到很多 https://pixabay.com/