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

我想添加自定义(非项目)文件来与Doxygen生成一些额外的页面。

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

在find答案之前,我一直在寻找相当多的东西,所以我认为这将是很好的分享!

根据这个Doxygen gotchas文章,我终于发现:你需要添加一个dox扩展名的文件。 其内容应该包含C风格的评论块:

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

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

为了完整性,有三种可能的扩展名,doxygen将其作为附加的文档文件:.dox,.txt和.doc。

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

为了更加完整,从Doxygen版本1.8(我相信)开始,它现在支持与markdown语法非常相似的其他文本文件。 您不再需要使用C / C ++样式的注释块。 相反,只需编写几乎正常的文本,并确保文本文件位于INPUTpath中,并且您的doxygen扫描实际上会查找具有.markdown扩展名(或您select使用的任何其他扩展名,如.md)的文件。

为了清楚:

在.doxconfiguration文件中,将文件添加到INPUT指令中,如下所示:

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

如果文件有适当的扩展名,比如说.h或者.c,那么Doxygen会在没有添加INPUT指令的情况下find文件。 在文件内部使用正常的Doxygen标签,如在源文件中,即在注释块内部,如:

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

也可以使用其中的一个include标签,比如上面例子中的“\ htmlinclude”,代码中的任何地方。

只需在doxyfile中的INPUTmacros中列出您的自定义文件即可。 你可以select你认为合适的名字。 格式是带有Doxygen标签的文本。