考虑以下单文件项目。
/** \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方法来做到这一点。
答案 0 :(得分:2)
您可以通过更改布局文件来完成此操作。首先使用
生成布局文件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