Doxygen导航路径(面包屑)说明&小组目录

时间:2014-07-11 13:53:21

标签: doxygen

我正在尝试实现与Qt相同的功能,因为他们的文档导航路径与Windows 7-8(也可能是vista)相同,即显示从根(模块M)到组件的整个路径C和班级XM->C->X

很好的例子: http://doc.qt.io/qt-4.8/qnetworksession.html

我必须为root设置某种doxygen标签,它的子节点是它们的子节点吗?我检查了所有doxygen标签,但没有看到任何与导航路径相关的内容。

我正在使用doxygen 1.8.7,它在页脚中生成导航路径,但我点击的所有内容都以root身份显示。另外,我如何将导航放在页面/标题的顶部?

是否可以显示组内容表?我为每个模块分离了model.dox文件,它定义了新组并包含了section / subsections。没有显示目录的任何想法?使用\ mainpage \ page标签在(主)页面上一切正常。

我的小组示例:

/*! \defgroup module1 CommonModule
 *  
 *  \tableofcontents
 *
 *  Module description ..
 *  \section first Init
 */

2014年7月14日更新: 没有意识到Qt文档是使用qdoc工具构建的,而不是doxygen所以可以忽略编辑部分。问题仍然保持不变。根据我的经验,不可能将页面和组合在一起,因此无法生成包含所有类/名称空间/枚举列表等的模块页面。希望我错了。

2014年9月9日更新:

  • 页面不能包含所有类/命名空间/枚举等的自动生成列表。
  • Doxygen导航仅在浏览文件列表时显示文件路径,这是没有用的,因为我主要按类/命名空间浏览文档而不是文件,并且希望禁用文件列表生成。

编辑: 从查看Qt文档(源代码),我看到Qt模块都是doxygen页面,模块页面是手动编写的,而不是由doxygen自动生成的,因为它们可能无法使用\defgroup获取内容表的模块描述。如果需要他会做同样的事。 另一方面,导航路径仍然是一个很大的谜团,他们可能使用某种内部脚本,因为我看到\nextpage等自定义标签。奇怪的是,如何在谷歌上找到与doxygen导航有关的任何东西都很困难!

0 个答案:

没有答案