Doxygen可以处理MainPage.dox以外的页面

时间:2011-08-22 17:31:38

标签: documentation documentation-generation doxygen

如果您将MainPage.dox文件放在Doxygen的搜索路径中,它会将其添加到源文档上方Doxygen / html的输出中。但是你有多个文件,如MainPage.dox?或者你只限于一个?

2 个答案:

答案 0 :(得分:6)

Doxygen将识别并解析任何具有* .dox扩展名的文件,并将其包含在结果文档中。这些文件将产生的内容取决于文件中的doxygen注释。例如,如果要修改主页面,则需要注释如下:

/**
 * @mainpage
 * Documentation you want to occur on the main page.
 */

您还可以使用此技术创建应出现在其他页面上的文档:

/**
 * @page another_page Another Page
 * Documentation that will occur on another page.
 */

假设HTML输出,此表单将创建一个名为another_page.html的文件,其级别与index.html相同。标题为Another Page,引用的内容将随后出现。还将生成一个名为Related Pages的附加选项卡,该选项卡将包含指向以此方式创建的所有相关页面的链接。

这样的块可以出现在doxygen解析的任何文件中(包括头文件或源文件),并且可以包含多个页面的定义(上面的两个注释都可以在一个文件中)。它们所在的文件对生成的输出没有影响。

答案 1 :(得分:2)

从1.8.4开始,.md降价页面也可以作为单独的页面包含在内,.dox C ++就像评论/** */一样{{1}根据您的doxygenINPUT配置。

使用FILE_PATTERNS.md之间的一个区别是.dox文件生成的相关页面与基本名称相同,没有.md文件的扩展名,而{ {1}}仅生成名称由.md命令给出的页面。

仍然可以使用.dox个文件中的\page个命令。

例如,如果文件\page包含:

.md

这将在“相关页面”下生成2页,标题为:

  • md_page
  • Md Page 2