我正在尝试使用doxygen为C#应用程序生成文档.现在,我正在尝试创建一个主页,其中包含指向所记录应用程序的中心类的一些链接.
我使用markdown创建了页面,它看起来像这样:
\mainpage Project name ================== bla Important classes ------------------ * Class1 * Class2 * Class3
出于某种原因,doxygen不会自动生成此页面上相应类的链接.为了让事情变得奇怪,doxygen在代码文档中识别这些类名并生成相应的链接没有问题,因此,据我所知,这是一个主页问题.
有没有办法做到这一点,而不使用生成的类页面的硬编码链接?
我一直在尝试,因为我有类似的需求 - 我也有一个用Markdown编写的主页.这与Stephen的答案基本相同,但有更多信息.我正在使用doxygen 1.8.5.
将AUTOLINK_SUPPPORT设置为doxyfile中的NO:
您似乎需要完全限定的包名称
com.bigcorp.stuff.product.namespace.ClassName
您还需要一个引用命令来建立链接:
\ref com.bigcorp.stuff.product.namespace.ClassName
这至少意味着你可以限定输出文本
\ref com.bigcorp.stuff.product.namespace.ClassName "ClassName"
表示输出文本没有名称空间混乱.
将AUTOLINK_SUPPPORT设置为YES(或空白):
你并不需要的\ref
即com.bigcorp.stuff.product.namespace.ClassName
只会本身提供了一个链接到类,但确实有这样使用的混乱\ref
可能是清洁反正.
只是使用ClassName
仍然没有提供链接.似乎你需要包前言.
奇怪的是,将鼠标悬停在自动创建的链接上会产生目标类的弹出描述.但是,显式\ref
链接不会.