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

时间:2013-07-12 16:53:55

标签: documentation doxygen

我的旁白有代码段,例如,::SomePlatformAPI()不属于我的代码库,Doxygen警告

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

我尝试在其周围添加\code\endcode,但代码块会启动一个新段落并打破当前的旁白。

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

更新

这只是Doxygen 1.8及以上版本的问题。 使用1.6,您没有此问题。

2 个答案:

答案 0 :(得分:11)

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

执行此操作时,代码将内联注入,但它将是等宽的,并且两个`标记之间的doxygen处理将被禁用。所以你不必逃避令牌。

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

code
{
    background-color:#EFD25E;
}

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

<code></code>

答案 1 :(得分:1)

自己找到解决方案:

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