documentation - 如何在Doxygen的 Markdown 文档之间链接？

Question

我有一个项目，其中包含一组 Markdown 页面，这些页面与诸如

[Go to this page](subdir/MyOtherPage.md)

所有页面都被doxygen拾取并出现在输出中，但是链接未更改以指向其新的html格式。

我可以更改链接以指向html页面，但是我的项目托管在github上，然后这些链接将被破坏，因为github支持自动在markdown页面之间进行链接。

在doxygen文档中，我看不到任何有关支持外部链接以外的链接的信息。有什么方法可以使doxygen从markdown生成HTML链接？

Answer 1

根据Doxygen 1.8.7，有三种方法可以执行此操作:

使用原始问题中所述的标准markdown超链接。

使用@ref，并在目标之前加上md_以及任何子目录。

命名页面，并使用@ref引用该名称。

第一种方法很简单，并且在没有Doxygen的情况下也可以使用(例如，在Github上浏览代码存储库时)。

[Go to this page](subdir/MyOtherPage.md)

而第二种方法则需要像这样链接它:

[Go to this page](@ref md_subdir_MyOtherPage)

显然这也是 the way prescribed by the Doxygen's primary author。

最后，在第三种方法中，您需要为目标页面指定一个名称，然后链接到该名称。例:

在 MyOtherPage.md中将此作为标题

# My Other Page Title {#MyOtherPageName}

然后像这样链接

[Go to this page](@ref MyOtherPageName)