Doxygen 用法

Doxygen 是一个基于命令行的实用工具。在命令行调用 doxygen 并带上 --help 选项,将显示该程序的简要用法说明。

所有选项都由一个前导字符 - 组成,后跟一个字符以及一个或多个参数,具体取决于选项。

要为您的项目生成手册,您通常需要遵循以下步骤

  1. 使用特殊的文档块来注释您的源代码(参见 特殊注释块 一节)。
  2. 通过使用 -g 选项调用 Doxygen 来生成配置文件(参见 配置 一节)
    doxygen -g <config_file>
    
  3. 编辑配置文件,使其符合您的项目。在配置文件中,您可以指定输入文件和许多可选信息。
  4. 根据配置文件中的设置,让 Doxygen 生成文档
    doxygen <config_file>
    

如果您有使用旧版本 Doxygen 生成的配置文件,可以通过运行 Doxygen 并带上 -u 选项将其升级到当前版本。

doxygen -u <config_file>

原始配置文件中的所有配置设置将被复制到新的配置文件。任何新选项将具有其默认值。请注意,您在原始配置文件中添加的注释将会丢失。

微调输出

如果您想微调输出的外观,Doxygen 允许您生成默认的样式表、页眉和页脚文件,供您后续编辑

  • 对于 HTML 输出,您可以使用以下命令生成默认的页眉文件(参见 HTML_HEADER)、默认的页脚(参见 HTML_FOOTER)和默认的样式表(参见 HTML_STYLESHEET

    doxygen -w html header.html footer.html stylesheet.css <config_file>
    

    The config_file 是可选的。省略时,Doxygen 会搜索名为 Doxyfile 的文件并处理它。如果也找不到,则会使用默认设置。

  • 对于 {\LaTeX} 输出,您可以使用以下命令生成 refman.tex 文件的开头和结尾部分(参见 LATEX_HEADERLATEX_FOOTER)以及该开头部分包含的样式表(通常是 doxygen.sty
    doxygen -w latex header.tex footer.tex doxygen.sty <config_file>
    
    如果您需要非默认选项(例如,使用额外的 {\LaTeX} 宏包),您需要创建一个配置文件,正确设置这些选项,然后在生成的文件之后指定该配置文件(请先备份配置文件,以免忘记指定输出文件而丢失它)。
  • 对于 RTF 输出,您可以使用以下命令生成默认样式表文件(参见 RTF_STYLESHEET_FILE
    doxygen -w rtf rtfstyle.cfg
    
警告
使用自定义页眉时,您负责正确包含 Doxygen 所需的任何脚本和样式表,这取决于配置选项,并且在升级到新的 Doxygen 版本时可能会发生变化。
注意
  • 如果您不希望配置文件中的每个条目都有文档说明,则可以使用可选的 -s 选项。此选项可与 -u 选项结合使用,以在现有配置文件中添加或删除文档说明。要获得最小的配置文件,请使用 -x 或 -x_noenv 选项,仅显示与默认 Doxygen 配置文件的差异。如果您向我发送配置文件作为错误报告的一部分或在 GitHub 上提交问题,请使用 -s-x-x_noenv 选项!(另请参见:如何报告错误
  • 要让 Doxygen 从标准输入/输出读写,而不是从/写到文件,请对文件名使用 -

转到 下一节 或返回 目录