你如何订购Doxygen自定义页面

Question

我在Doxygen中创建了许多自定义页面.我想自定义主菜单中页面的顺序.下面是我当前导航菜单的图片.我想改变顺序,所以概述是第一,安装第二,介绍第三,等等.有没有办法做到这一点？

Answer 1

经过一些调查，似乎 Doxygen 目前不支持以自定义（或任何）方式对页面进行排序。

正如@Toby 提到的，当前确保 Doxygen 中所需页面顺序的方法是确保以相同顺序解析页面条件 (\page)。例如，您可以通过手动指定文件来实现所需的顺序，例如：

INPUT = Developers.dox \
        Hive_Training.dox \
        Installation.dox \
        Introduction.dox \
        Models.dox \
        Overview.dox \
        Users.dox \
        Files.dox

这一点都不理想，但它有效。我发现，如果您希望在 Doxygen 配置文件中使用目录路径进行维护，您可以创建一个“页面顺序”文件，以便在任何其他内容之前先进行解析。例如：

INPUT += PageOrder.dox
INPUT += ../my_module_1/content/
INPUT += ../my_module_2/content/

然后将所有页面引用添加到PageOrder.dox文件中：

\page developers Developers
\page hive_training Hive Training
\page installation Installation
\page introduction Introduction
\page models Models
\page overview Overview
\page users Users
\page files Files

这又是不理想的；但是，您的维护过程现在驻留在单页订单文件中（而不是接触一 (1) 个或多个 Doxygen 配置文件）。

Answer 2

Doxygen 按字母顺序处理自定义页面文件名。

因此，您可以将自定义页面文件命名为：

• _1_file1.dox
• _2_file2.dox
• 等等...

因此，它们将在生成的文档中以相同的顺序出现。此解决方案避免修改任何配置文件！

Answer 3

我找到了一种相当麻烦的方法来实现这一目标。以前，我将所有自定义 doxygen 文件（图像、页面等）放在一个名为 input 的目录中。

我将每个页面放在单独的文件中（例如 main_page.dox、page1.dox、page2.dox 等）

我将自定义页面移至与输入目录处于同一级别的名为pages 的单独目录。

（我还将输入目录重命名为图像，并IMAGE_PATH相应地更改了）

然后，在 doxygen 配置文件中，我按照我想要的顺序INPUT将每个页面文件的显式路径添加到变量中。例如：

INPUT= . Documentation\images \ 
      Documentation\pages\main_page.dox \
      Documentation\pages\page2.dox \
      Documentation\pages\page3.dox

这意味着每次添加新页面时，我都必须将其路径添加到INPUT，所以正如我在顶部所说，这很麻烦。但比在介绍等之前出现结论要好

这适用于 HTML 和 LaTeX - 尚未测试其他格式