学习用doxygen生成源码文档

<EXTRACT_STATIC> ：把这个标记设置为 Yes。否则，文档不包含文件的静态成员（函数和变量）。

清单 3 给出一个 Doxyfile 示例。

清单 3. 包含用户提供的标记值的doxyfile 示例

OUTPUT_DIRECTORY = /home/user1/docs
EXTRACT_ALL = yes
EXTRACT_PRIVATE = yes
EXTRACT_STATIC = yes
INPUT = /home/user1/project/kernel
#Do not add anything here unless you need to. Doxygen already covers all
#common formats like .c/.cc/.cxx/.c++/.cpp/.inl/.h/.hpp
FILE_PATTERNS =
RECURSIVE = yes

运行 doxygen

在 shell 提示下输入 doxygen Doxyfile（或者 已为配置文件选择的其他文件名）运行 doxygen。在最终生成 Hypertext Markup Language（HTML）和 Latex 格式（默认）的文档之前，doxygen 会显示几个消息。在生 成文档期间，在 <OUTPUT_DIRECTORY> 标记指定的文件夹中，会创建两个子文件夹 html 和 latex。清单 4 是一个 doxygen 运行日志示例。

清单 4. doxygen 的日 志输出

Searching for include files...
Searching for example files...
Searching for images...
Searching for dot files...
Searching for files to exclude
Reading input files...
Reading and parsing tag files
Preprocessing /home/user1/project/kernel/kernel.h
…
Read 12489207 bytes
Parsing input...
Parsing file /project/user1/project/kernel/epico.cxx
…
Freeing input...
Building group list...
..
Generating docs for compound MemoryManager::ProcessSpec
…
Generating docs for namespace std
Generating group index...
Generating example index...
Generating file member index...
Generating namespace member index...
Generating page index...
Generating graph info page...
Generating search index...
Generating style sheet...

文档输出格式

除了 HTML 之外，doxygen 还可以生成几种输出格式的文档。可以让 doxygen生 成以下格式的文档：

UNIX 手册页：把 <GENERATE_MAN> 标记设置为 Yes。 在默认情况下，会在 <OUTPUT_DIRECTORY> 指定的目录中创建 man 子文件夹，生 成的文档放在这个文件夹中。必须把这个文件夹添加到 MANPATH 环境变量中。

Rich Text Format（RTF）：把 <GENERATE_RTF> 标记设置为 Yes。把 <RTF_OUTPUT> 标记设置为希望放置 .rtf 文件的目录；在默认情况下，文档放在 OUTPUT_DIRECTORY 中的rtf 子文件夹中。要想支持跨文档浏览，应该把 <RTF_HYPERLINKS> 标记设置为 Yes。如果设置这个标记，生成的.rtf 文件会包含 跨文档链接。

Latex：在默认情况下，doxygen生成 Latex 和 HTML 格式的文档。 在默认的Doxyfile 中，<GENERATE_LATEX> 标记设置为 Yes。另外， <LATEX_OUTPUT> 标记设置为 Latex，这意味着会在 OUTPUT_DIRECTORY 中创建 latex 子文件夹并在其中生成 Latex 文件。

Microsoft® Compiled HTML Help（CHM）格式：把 <GENERATE_HTMLHELP> 标记设置为 Yes。因为在 UNIX 平台 上不支持这种格式，doxygen 只在保存 HTML 文件的文件夹中生成一个 index.hhp 文件 。您必须通过 HTML 帮助编译器把这个文件转换为 .chm 文件。

Extensible Markup Language（XML）格式：把 <GENERATE_XML> 标记设置为 Yes。（注意， doxygen 开发团队还在开发 XML 输出）。

清单 5 提供的Doxyfile 示例让 doxygen生成所有格式的文档。

清单 5.生成多种格式的文档的 Doxyfile

#for HTML
GENERATE_HTML = YES
HTML_FILE_EXTENSION = .htm
#for CHM files
GENERATE_HTMLHELP = YES
#for Latex output
GENERATE_LATEX

凌众科技专业提供服务器租用、服务器托管、企业邮局、虚拟主机等服务，公司网站：http://www.lingzhong.cn 为了给广大客户了解更多的技术信息，本技术文章收集来源于网络,凌众科技尊重文章作者的版权，如果有涉及你的版权有必要删除你的文章，请和我们联系。以上信息与文章正文是不可分割的一部分,如果您要转载本文章,请保留以上信息，谢谢!