考虑以下单文件项目。
/** \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
, and Files
分别。
如果我点击Modules
,我看到所有模块的列表,其中仅包含一个模块。然后,我必须单击模块名称才能查看该模块的文档。
Doxygen 中是否存在一个选项可以让我避免最终点击?
也就是说,如果我的项目中只有一组,我希望生成的 HTML 只需要单击Modules
选项卡显示一组。
我意识到我可以手动编辑生成的 html,但我正在寻找 in-doxygen 方法来执行此操作。
您可以通过更改布局文件来实现此目的。首先使用生成布局文件
doxygen -l
然后在你的Doxyfile集中
LAYOUT_FILE = DoxygenLayout.xml
现在编辑 DoxygenLayout 文件并替换
<tab type="modules" visible="yes" title="" intro=""/>
with
<tab type="user" visible="yes" url="@ref api" title="API" intro=""/>
可以在此处找到有关 doxygen 布局文件的更多信息:http://www.doxygen.nl/manual/customize.html#layout http://www.doxygen.nl/manual/customize.html#layout
本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)