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

我想添加自定义（非项目）文件以生成Doxygen的一些额外页面。如何在Doxygen中包含自定义文件

我（实际上）不确定应如何命名这些文件以及如何对其内容进行格式化。

2010-06-16 Veger

在找到答案之前，我一直在寻找很多东西，所以我认为这将很高兴分享！

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

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

确保您的自定义文件放在其中包括在INPUT设置或在当前目录中，如果输入为空目录，所以这些文件可以发现。

来源

2010-06-16 09:29:21 Veger

我认为你的代码示例有一个小错误。 “page”特殊命令之前的标记必须是“@”或“\”。我试图按照原样使用您的示例，但未生成页面，但是使用该小修补程序可以正常工作。 – wil 2012-03-12 01:57:26

Markdown现在也可用。 [Here's]（http://stackoverflow.com/a/9522667/339872）如何使用它。 – antitoxic 2012-03-13 11:18:07

只需将您的自定义文件列在doxyfile的INPUT宏中。你可以选择你认为合适的名字。格式是带有Doxygen标签的文本。

来源

2010-06-16 09:33:50 mouviciel

我试过了，但文件被包含为源文件（添加到文件列表中）。使用dox扩展似乎可以防止这种情况 – Veger 2010-06-16 10:36:37

只是为了完整：有3种可能的扩展名，它们将doxygen视为额外的文档文件：.dox，.txt和.doc。

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

来源

2011-06-13 21:07:37 doxygen

+14

由于这在google上仍然非常流行：看起来像现在，.md必须添加到该列表中。 – Lukx 2015-02-03 12:58:37

使用doxygen 1.8.13，.txt不起作用。 .md适合我。 – Fabian 2017-05-05 06:45:17

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

来源

2012-05-22 17:12:04 DXM

我并不积极（可能将此视为一个问题），但我没有看到将\ dot这样的命令添加到降价文档中的方法。 – pedz 2014-01-26 01:11:27

@pedz：自从我跟Doxygen打过一段时间后（换了一段时间的工作），所以不记得所有的细节。您不能将任何自定义标签添加到降价。它必须得到解析器的支持，但我相信“\ dot”是一个有效的标记：http://www.stack.nl/~dimitri/doxygen/manual/commands.html#cmddot。因此可能a）您的配置文件中没有正确的版本或b）您没有指定DOT工具可用。 – DXM 2014-01-26 02:55:53

为清楚：

在.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 
*/

人们可以也只是在上面的例子中使用包括标签中的一个，像“\ htmlinclude”，任何在代码中的哪里。

来源

2014-03-25 06:47:27 Wiley

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

回答

相关问题