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

在找到答案之前,我已经搜索了很多次了,所以我觉得分享一下会很好!

根据这个 Doxygen gotchas 文章我终于发现:你需要添加一个文件 氧化铁 延伸。其内容应包含C样式的注释块:

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

确保将自定义文件放在包含在 INPUT 如果输入为空,则设置或在当前目录中,以便可以找到这些文件。

只是为了完整性:有3个可能的扩展名,doxygen将其视为附加文档文件:.dox、.txt和.doc。

该扩展名在文件索引中隐藏的文件。在文件中,您需要放置一个或多个C/C++风格的注释块。

为了更加完整,从1.8版的doxygen开始(我相信),它现在支持与 markdown 语法。您不再需要使用C/C++风格的注释块。相反,只要写 几乎 正常文本,并确保文本文件在输入路径中,并且您的Doxygen扫描实际上查找扩展名为.markdown的文件(或您选择使用的任何其他扩展名,如.md)。

为了清晰:

在.dox配置文件中,使用 这样地:

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”,代码中的任何位置。

只需在doxy文件的输入宏中列出自定义文件。你可以选择你认为合适的名字。格式是带有doxygen标记的文本。