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

问题描述

考虑以下单文件项目。

  / ** \defgroup api公共API * / 
 
 / ** 
 *这是foo和bar在一起。 
 * \inggroup api 
 * / 
 void foobar（）{
 //没有这里可以看到。 
} 
  

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

  doxygen -g 
 doxygen Doxyfile 
  

当我打开 html / index.html 时，我看到三个标签为主页，模块和文件

如果我点击模块，我看到所有模块的列表，它只包含一个模块。我必须单击模块名称才能查看该模块的文档。

Doxygen中是否存在一个可以避免最终点击的选项？

也就是说，如果我的项目中只有一个组，我希望生成的HTML只需要点击模块选项卡显示一个组。

我意识到我可以手动编辑生成的html，但我正在寻找do-doxygen的方法来实现。

解决方案

您可以通过更改布局文件来实现此目的。首先使用

  doxygen -l 
   
 
 
然后在您的Doxyfile集
  LAYOUT_FILE = DoxygenLayout.xml 
  
现在编辑DoxygenLayout文件并替换
 < tab type =modulesvisible =yestitle =intro =/> 
  
与
 < tab type =uservisible =yesurl =@ ref apititle =APIintro =/> 
  
可以在这里找到更多关于doxygen布局文件的信息： https://www.stack.nl/~dimitri/doxygen/manual/customize.html#layout  
 
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.
解决方案
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: https://www.stack.nl/~dimitri/doxygen/manual/customize.html#layout

                        
这篇关于单击“模块”选项卡时，Doxygen是否可以直接显示唯一的模块？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！