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 处于同一级别。标题将为另一页，后面将引用内容。还将生成一个名为“相关页面”的附加选项卡，其中包含指向以这种方式创建的所有相关页面的链接。

像这样的块可以出现在 doxygen 解析的任何文件中（包括头文件或源文件），并且可以包含多个页面的定义（上面的两个注释都可以在单个文件中）。它们所在的文件不会对生成的输出产生影响。

Answer 2

从 1.8.4 开始，.md markdown 页面也可以作为单独的页面包含在内，而无需 .dox C++ 之类的注释 /** */ 如果 doxygen 根据您的 INPUT 和 FILE_PATTERNS 配置考虑它们。

使用 .md 和 .dox 之间的一个区别是，.md 文件生成一个与基本名称同名的相关页面，但没有扩展名.md 文件，而 .dox 只生成由 \page 命令指定名称的页面。

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

例如，如果文件 md_page.md 包含：

Inside md_page.

\page md_page2 Md Page 2

Inside md_page2

这将在“相关页面”下生成 2 个页面，标题为：

• md_page
• Md Page 2