Markdown doxygen主页上自动生成的类引用链接
我正在尝试使用doxygen为C#应用程序生成文档。现在,我正在尝试创建一个主页,其中包含一些指向文档化应用程序中心类的链接 我已经使用markdown创建了页面,它看起来像这样:Markdown doxygen主页上自动生成的类引用链接,markdown,doxygen,Markdown,Doxygen,我正在尝试使用doxygen为C#应用程序生成文档。现在,我正在尝试创建一个主页,其中包含一些指向文档化应用程序中心类的链接 我已经使用markdown创建了页面,它看起来像这样: \mainpage Project name ================== bla Important classes ------------------ * Class1 * Class2 * Class3 出于某种原因,doxygen不会自动生成指向此页面上相应类的链接。让事情变得奇怪的是,doxyg
\mainpage
Project name
==================
bla
Important classes
------------------
* Class1
* Class2
* Class3
出于某种原因,doxygen不会自动生成指向此页面上相应类的链接。让事情变得奇怪的是,doxygen在代码文档中识别这些类名并生成相应的链接没有问题,因此,据我所知,这是一个主页问题
有没有办法不用硬编码链接到生成的类页面就可以做到这一点?我终于找到了!用名称空间名称作为类名的前缀,如
Namespace1.Class1
,成功了
这仍然很奇怪,因为doxygen在其他地方处理短类名没有问题,但是,嘿,它可以工作 我一直在试验,因为我有类似的需求——我也有一个用降价法编写的主页。这与Stephen的答案基本相同,但有更多的信息。我使用的是doxygen 1.8.5 在doxyfile中将自动链接支持设置为否: 似乎您需要完全限定的包名
com.bigcorp.stuff.product.namespace.ClassName
您还需要一个引用命令来创建链接:
\ref com.bigcorp.stuff.product.namespace.ClassName
这至少意味着您可以限定输出文本
\ref com.bigcorp.stuff.product.namespace.ClassName“ClassName”
表示输出文本没有名称空间混乱
自动链接支持设置为是(或空白):
您不需要\ref
,即com.bigcorp.stuff.product.namespace.ClassName
只提供指向类本身的链接,但确实存在混乱,因此使用\ref
可能更干净
仅仅使用ClassName
仍然不能提供链接。看来你需要这个包裹
奇怪的是,将鼠标悬停在自动创建的链接上会生成目标类的弹出式描述。但是,显式的
\ref
链接不起作用。我发现了如何避免在每个类上添加冗长的\ref并保留类工具提示
您只需将注释放在名称空间中即可
namespace com.bigcorp.stuff.product.namespace
{
/// \page page_name Page Name
/// This is a working class auto ref -> ClassName.
}
但这对多个名称空间中的类不起作用…很好的解释。奇怪的是,HIDE_SCOPE_名称在这种情况下不起作用,但它不起作用-我已经尝试过了。