Doxygen是否可以处理MainPage.dox以外的页面 [英] Can Doxygen process pages other than MainPage.dox

问题描述

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

If you put a MainPage.dox file in Doxygen's search path, it will add it to the output in Doxygen/html above the source documentation. But can you have multiple files like MainPage.dox? Or are you limited to one?

推荐答案

Doxygen将识别并解析任何带有* .dox扩展名的文件，并将其包含在结果文档中。这些文件将产生什么，取决于文件中的doxygen注释。例如，如果要修改主页，则需要这样的注释：

Doxygen will recognize and parse any file that has a *.dox extension and include it in the resulting documentation. What those files will produce is dictated by the doxygen comments located in the file. For example, if you want to modify the main page, you'll need a comment like:

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

您还可以使用以下方法创建应显示在其他页面上的文档：

You can also create documentation that should appear on other pages using this technique:

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

假设HTML输出，此表单将创建一个名为<$ c $的文件c> another_page.html 与 index.html 处于同一级别。标题将是另一个页面，随后将涉及所引用的内容。还将产生一个名为相关页面的附加选项卡，该选项卡将包含以这种方式创建的所有相关页面的链接。

Assuming HTML output, this form will create a file named another_page.html at the same level as index.html. The title will be Another Page, and the content referenced will follow. An additional tab will also be produced named Related Pages which will have links to all of the related pages created in this manner.

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

Blocks like this can occur in any file that doxygen parses (including header or source files), and can contain definitions for multiple pages (both of the comments above could be in a single file). The file they're located in does not have an impact on the output that is produced.

这篇关于Doxygen是否可以处理MainPage.dox以外的页面的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！