我正在编写一个C#库,希望从我的mainpage.md
文件链接到某些类的页面。但是,我可以让Doxygen从主页的文本中创建链接的唯一方法是在主页中写入类的完全限定名称(例如com.mycompany.myproject.MyClass
),这有点难以阅读和反复写作真正的痛苦。我希望能够在主页中写下MyClass
并将其链接到com.mycompany.myproject.MyClass
。
我的项目中只有一个命名空间:有什么方法可以让主页假设所有名称都隐含在这个命名空间中?最糟糕的是,有没有一种很好的方法可以在生成过程中从类名中截断命名空间?现在,我最好的解决方案是在运行Doxygen后自行编辑sed
来运行我的HTML文件。
答案 0 :(得分:1)
尝试使用HIDE_SCOPE_NAMES
:
HIDE_SCOPE_NAMES = YES
http://www.doxygen.nl/manual/config.html#cfg_hide_scope_names
如果HIDE_SCOPE_NAMES标记设置为NO(默认值),则为Doxygen 将向成员显示其完整的类和命名空间范围 文档。如果设置为YES,则隐藏范围。
所以使用它应该允许:
com.mycompany.myproject.MyClass
成为:
MyClass
答案 1 :(得分:1)
我终于在doxygen: how to create hyperlinks to class definitions from Mainpage.dox?的评论中找到了答案。
基本上,答案是将我的mainpage.md
文件更改为mainpage.dox
文件,并使用namespace
声明环绕我的主页,如下所示:
namespace com.mycompany.myproject {
/**
* {mainpage text here}
*/
}
这使得主页在命名空间内,并指示Doxygen在右侧命名空间中查找主页正文中提到的任何类名。