如何在Doxygen中包含自定义文件

Question

我想添加自定义（非项目）文件以使用Doxygen生成一些额外的页面。

我（实际上）不确定应该如何命名这些文件以及如何格式化它们的内容。

Answer 1

在找到答案之前我一直在搜索很多，所以我觉得分享会很好！

根据这篇Doxygen gotchas文章，我终于发现：您需要添加一个包含 dox 扩展名的文件。其内容应包含C风格的注释块：

/*!
  \page My test page
  contents
  ...
  more contents
*/

确保您的自定义文件放在INPUT设置中包含的目录中，或者如果INPUT保留为空，则放在当前目录中，以便找到这些文件。

Answer 2

为了完整性：有3种可能的扩展，doxygen将其视为附加文档文件：.dox，.txt和.doc。

从文件索引中隐藏此类扩展名的文件。在文件内部，您需要放置一个或多个C / C ++样式注释块。

Answer 3

为了更加完整，从Doxygen版本1.8（我相信）开始，它现在支持与markdown语法非常相似的其他文本文件。您不再需要使用C / C ++样式注释块。相反，只需编写几乎普通文本并确保文本文件位于INPUT路径中，并且doxygen扫描实际上会查找扩展名为.markdown的文件（或您选择使用的任何其他扩展名，像.md）。

Answer 4

为清楚起见：

在.dox配置文件中，将文件添加到INPUT指令中 像这样：

INPUT = ../src \
        ../include \
        ../docs/my-extra-file.txt

如果文件具有适当的扩展名，比如.h或.c，那么Doxygen会在不添加INPUT指令的情况下找到该文件。在文件内部使用普通的Doxygen标签，如在源中，即内部注释块，如：

/*! \mainpage MyProject - A Brief Description.
\image html Mylogo.png
\section my-intro MyProject Introduction
\htmlinclude about-MyProject.html
*/

也可以使用其中一个include标记，例如上例中的“\ htmlinclude”，代码中的任何位置。

Answer 5

只需在doxyfile的INPUT宏中列出自定义文件即可。您可以选择适当的名称。格式是带有Doxygen标签的文本。