单击“模块”选项卡时，是否可以让Doxygen直接显示唯一的模块？(Is it possible to have Doxygen directly show the only module when

单击“模块”选项卡时，是否可以让Doxygen直接显示唯一的模块？(Is it possible to have Doxygen directly show the only module when clicking the Modules tab?)

考虑以下单文件项目。

/** \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方法来做到这一点。

Consider the following single-file project.

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

In the directory containing this file, I run the following commands.

doxygen -g doxygen Doxyfile

When I open html/index.html, I see three tabs titled Main Page, Modules, and Files respectively.

If I click on Modules, I see a list of all modules, which contains only a single module. I must then click on the module name to see the documentation for the module.

Does there exist an option in Doxygen which allows me to avoid the final click?

That is, if I have only one group in my project, I would like the generated HTML to only require clicking on the Modules tab to show the one group.

I realize that I can manually edit the generated html, but I am looking for in-doxygen ways to do this.

最满意答案

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

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布局文件的信息： https ： //www.stack.nl/~dimitri/doxygen/manual/customize.html#layout

You can accomplish this by changing the layout file. First generate a layout file using

doxygen -l

then in your Doxyfile set

LAYOUT_FILE = DoxygenLayout.xml

Now edit the DoxygenLayout file and replace

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

with

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

Can find more info on doxygen layout file here: http://www.doxygen.nl/manual/customize.html#layout