documentation - Doxygen 可以处理除 MainPage.dox 之外的页面

Question

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

Answer 1

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 解析的任何文件中(包括头文件或源文件)，并且可以包含多个页面的定义(上面的两个注释都可以在一个文件中)。它们所在的文件对生成的输出没有影响。