【发布时间】:2020-09-09 18:34:19
【问题描述】:
我正在从事 C++11 项目,我们使用 Doxygen 创建漂亮的 html API 文档。
我注意到当我直接在hpp文件中写入类名时,doxygen会生成对应类的链接。
但是当我在 *.md 文件中写入相同的类名时,不会生成链接。
我需要在配置中启用它还是使用特殊语法来启用链接?
【问题讨论】:
-
看看
\link,\ref命令
我正在从事 C++11 项目,我们使用 Doxygen 创建漂亮的 html API 文档。
我注意到当我直接在hpp文件中写入类名时,doxygen会生成对应类的链接。
但是当我在 *.md 文件中写入相同的类名时,不会生成链接。
我需要在配置中启用它还是使用特殊语法来启用链接?
【问题讨论】:
\link, \ref 命令
当我用<code><pre>...</pre></code>替换markdown代码块时,我能够自动生成链接:
// link to MyClass is not generated
\```C++
Doc is about MyClass...
\```
|
v
// link to MyClass is generated
<code>
<pre>
Doc is about MyClass...
</pre>
</code>
UPD:添加了反斜杠,以便它们在 StackOverflow 上正确呈现。
【讨论】:
<code> 的结尾应该是</code>。当我尝试代码时,我确实看到了所有指向MyClass 的链接。为什么在 <code> 块内使用 <pre>?您使用的是哪个版本的 doxygen,您的降价文件的名称是什么?另请注意,C++ 应为 cpp。
introduction.md。 用于代码块。