如何用Doxygen生成内联代码段？

Question

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

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

我试图添加\code并\endcode围绕它,但然后代码块启动一个新段落并打破当前的叙述.

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

更新:

事实证明这只是Doxygen 1.8及以上版本的问题.使用1.6,您没有此问题.

Answer 1

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

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

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

code
{
    background-color:#EFD25E;
}

这将是内联代码的hylight.Doxygen的代码跨度使用自定义标记

<code></code>

Answer 2

自己找到了解决方案：

我需要做的就是转义该::令牌和其他类似的令牌->。

例如

\:\: 

\-\>