【问题标题】:How to automatically create links to C++ classes in markdown using doxygen?如何使用 doxygen 在 markdown 中自动创建指向 C++ 类的链接?
【发布时间】:2020-09-09 18:34:19
【问题描述】:

我正在从事 C++11 项目,我们使用 Doxygen 创建漂亮的 html API 文档。

我注意到当我直接在hpp文件中写入类名时,doxygen会生成对应类的链接。

但是当我在 *.md 文件中写入相同的类名时,不会生成链接。

我需要在配置中启用它还是使用特殊语法来启用链接?

【问题讨论】:

  • 看看\link, \ref 命令

标签: c++ markdown doxygen


【解决方案1】:

当我用<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 上正确呈现。

【讨论】:

  • 带有反斜杠和 (3) 反引号的结构有点奇怪,这应该只是 3 个反引号。代码块&lt;code&gt; 的结尾应该是&lt;/code&gt;。当我尝试代码时,我确实看到了所有指向MyClass 的链接。为什么在 &lt;code&gt; 块内使用 &lt;pre&gt;?您使用的是哪个版本的 doxygen,您的降价文件的名称是什么?另请注意,C++ 应为 cpp
  • Doxygen 版本为 1.8.18,文件名为introduction.md
     用于代码块。
猜你喜欢
  • 2019-07-10
  • 2016-11-25
  • 2012-03-28
  • 2017-05-31
  • 2015-09-26
  • 2015-10-12
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
相关资源
最近更新 更多