documentation - 如何使用 Doxygen 生成内联代码部分？

Question

我的叙述有代码片段，例如，::SomePlatformAPI()不属于我的代码库的一部分，Doxygen 警告说

warning: explicit link request to 'SomePlatformAPI()' could not be resolved

我试图添加\code并\endcode围绕它，但随后代码块开始了一个新段落并打破了当前的叙述。

有没有办法添加内联代码块？

更新：

原来这只是 Doxygen 1.8 及更高版本的问题。使用 1.6，您没有这个问题。

score 18 · Accepted Answer

Doxygen 降价支持允许您使用 ` 反引号字符插入内联代码块。 http://www.doxygen.nl/manual/markdown.html#md_codespan

当你这样做时，代码将被内联注入，但它将是等宽的，并且在两个 ` 标记之间将禁用 doxygen 处理。所以你不必逃避令牌。

事实上，为了让它更加突出，我添加了一个额外的样式表，其中包含以下内容：

code
{
    background-color:#EFD25E;
}

这将突出内联代码。Doxygen 的代码跨度使用自定义标签

<code></code>

score -2 · Accepted Answer

自己找到了解决方案：

我需要做的就是逃避::token 和其他类似的 tokens ->。

例如

\:\: 

\-\>

2 回答 2