回答
在找到答案之前,我一直在寻找很多东西,所以我认为这将很高兴分享!
根据这一Doxygen gotchas文章我终于发现:你需要添加一个文件与DOX扩展。其内容应包含C风格的注释块:
/*!
\page My test page
contents
...
more contents
*/
确保您的自定义文件放在其中包括在INPUT设置或在当前目录中,如果输入为空目录,所以这些文件可以发现。
只需将您的自定义文件列在doxyfile的INPUT宏中。你可以选择你认为合适的名字。格式是带有Doxygen标签的文本。
我试过了,但文件被包含为源文件(添加到文件列表中)。使用dox扩展似乎可以防止这种情况 – Veger 2010-06-16 10:36:37
为了更加完整,从Doxygen版本1.8(我相信)开始,它现在支持与markdown语法非常相似的其他文本文件。您不再需要使用C/C++样式的注释块。相反,只需编写几乎正常文本并确保文本文件位于INPUT路径中,并且doxygen扫描实际上会查找带.markdown扩展名(或您选择使用的任何其他扩展名,如.md)的文件。
我并不积极(可能将此视为一个问题),但我没有看到将\ 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”,任何在代码中的哪里。
- 1. 如何将Wordpress文章包含在自定义PHP文件中?
- 2. 如何在doxygen文档中包含文件夹?
- 3. 如何在.tpl中包含自定义JS(JQuery)文件?
- 4. 如何在我的自定义库文件中包含会话?
- 5. 如何在ClickOnce部署中包含自定义数据文件?
- 6. 如何编写自动包含在Doxygen输出中的自述文件?
- 7. 如何用Doxygen文件包含文件包括
- 8. 如何在Doxygen注释中包含.cpp文件的子集?
- 9. ListView包含在自定义控件中
- 10. setup.py包含自定义数据文件
- 11. eclipse包含自定义文件(c)
- 12. 包含自定义头文件(ANSI C)
- 13. 在doxygen中包含MS-Word文档
- 14. 在SVN仓库中包含doxygen文档
- 15. PegKit自定义包含文件的自定义操作
- 16. 在WordPress插件中包含自定义字体文件
- 17. 如何在自定义插件中包含Java编译任务?
- 18. 如何在Doxygen中创建一个仅包含“公共”API文件的文件
- 19. 如何在构建过程中包含自定义文本文件
- 20. 如何在Sandcastle帮助文件中包含自定义文档注释元素?
- 21. MEANJS样板文件:其中包含自定义JavaScript文件?
- 22. 如何包含一个自定义的php文件?
- 23. 如何使用自定义taglib包含jsp文件?
- 24. 在XCode中包含自定义框架的头文件
- 25. 在控制器中包含自定义异常文件
- 26. 在自定义extjs主题中包含现有的CSS文件
- 27. 要包含在补丁msp文件中的自定义表
- 28. 如何让Doxygen记录在C++文件中定义的类?
- 29. 如何包含自定义SQL函数
- 30. 如何包含自定义C库
我认为你的代码示例有一个小错误。 “page”特殊命令之前的标记必须是“@”或“\”。我试图按照原样使用您的示例,但未生成页面,但是使用该小修补程序可以正常工作。 – wil 2012-03-12 01:57:26
Markdown现在也可用。 [Here's](http://stackoverflow.com/a/9522667/339872)如何使用它。 – antitoxic 2012-03-13 11:18:07