是否可以让 Doxygen 在单击 Modules 选项卡时直接显示唯一的模块？

Question

考虑以下 single-file 项目。

/** \defgroup api Public API */

/**
 * This is foo and bar together.
 * \ingroup api
 */
void foobar() {
    // Nothing here to see.
}

在包含此文件的目录中，我运行执行以下命令。

doxygen -g
doxygen Doxyfile

当我打开 html/index.html 时，我看到三个标签，分别标题为 Main Page、Modules 和 Files。

如果单击 Modules，我会看到所有模块的列表，其中仅包含一个模块。然后我必须单击模块名称以查看模块的文档。

Doxygen 中是否存在允许我避免最终点击的选项？

也就是说，如果我的项目中只有一个组，我希望生成的 HTML 只需单击 Modules 选项卡即可显示该组。

我知道我可以手动编辑生成的 html，但我正在寻找 in-doxygen 方法来做到这一点。

Answer 1

您可以通过更改布局文件来完成此操作。首先使用

生成布局文件

doxygen -l

然后在你的 Doxyfile 中设置

LAYOUT_FILE = DoxygenLayout.xml

现在编辑 DoxygenLayout 文件并替换

<tab type="modules" visible="yes" title="" intro=""/>

和

<tab type="user" visible="yes" url="@ref api" title="API" intro=""/>

可以在此处找到有关 doxygen 布局文件的更多信息：http://www.doxygen.nl/manual/customize.html#layout

Is it possible to have Doxygen directly show the only module when clicking the Modules tab?