Documentation 异常标记中的Doxygen列表呈现不正确
符号主文档中的列表Documentation 异常标记中的Doxygen列表呈现不正确,documentation,doxygen,Documentation,Doxygen,符号主文档中的列表 /** * - foo * - bar * - wah */ 在Doxygen中以项目符号的形式很好地渲染: 异常标记的强氧剂包括: 该段[在@exception之后]的文本没有特殊的内部结构。可在段落内使用所有视觉增强命令。每个异常描述将从新行开始。当遇到空行或某些其他剖切命令时,\exception描述结束 尽管“所有视觉增强命令都可以在段落内使用”,但列表似乎无法在异常标记内正确呈现,这可能是由于对行尾的严格处理 相同的列表,在异常标记中 /** * @e
/**
* - foo
* - bar
* - wah
*/
在Doxygen中以项目符号的形式很好地渲染:
异常
标记的强氧剂包括:
该段[在@exception之后]的文本没有特殊的内部结构。可在段落内使用所有视觉增强命令。每个异常描述将从新行开始。当遇到空行或某些其他剖切命令时,\exception描述结束
尽管“所有视觉增强命令都可以在段落内使用”,但列表似乎无法在异常标记内正确呈现,这可能是由于对行尾的严格处理
相同的列表,在异常
标记中
/**
* @exception myError
* - foo
* - bar
* - wah
*/
渲染为间距奇怪的项目符号点:
Doxygen可能会将列表中的每个元素解释为一个单独的“异常描述”,并因此用换行符将它们分开。
如何避免这种行为,使列表以与主文档中相同的方式呈现为项目符号点
我正在使用Ubuntu上的Doxygen1.8.1318.04。是我的doxygen配置文件,它错误地呈现了以下MWE:
/**
* - foo
* - bar
* - wah
* @exception myError
* - foo
* - bar
* - wah
*/
void myFunc();
Doxygen 1.8.13已经有点老了(2016年12月),我当然建议更新到当前版本1.9.1,但这不是问题的原因/
提供的Doxyfile并不是真正最小的,它包含了许多与当前问题无关的项目特定的内容。带有
EXTRACT_ALL=YES
QUIET=YES
这就足够了
运行给定输入时,我们会得到:
问题是,我们希望在何处设置单词异常
和后续列表项?
目前,第一组列表项直到第二个-wu
之后才终止,异常
被视为第一个wu
列表项的一部分,第二个foo
被视为一级列表项,因此显示了上述输出
解决方案(而不是@exception
之后的项目前的额外空间,使其成为第二级列表):
结果:
可能是想要的解决方案(注意@exception
前面的空行,它终止了第一个列表):
结果:
(我用1.8.13版本运行了所有程序)您使用的是哪个版本的doxygen?请给出一个最小、完整的示例,说明问题所在,因为我无法使用给定的信息重现问题(使用默认设置文件,并在将/*
更正为/**``)。还要指定与默认设置不同的设置(
doxygen-x`新版本的输出)@albert,希望如此!我已经用版本更新了我的问题,并且你的解决方案在我的系统上正确呈现;也许我的配置中还有其他一些东西在起作用——如果我有远见知道哪一个是正确的,那么我会将其缩小到相关部分。从我展示的可能性来看,哪一个图像/解决方案对您来说是正确的?当你用你的设置运行它时,你会得到什么?(将此信息作为编辑添加到问题中)。如前所述,在您的Doxyfile中,我必须禁用许多系统依赖项,解决问题的最佳候选项是HTML\u页眉
,HTML\u页脚
,HTML\u额外\u样式表
,HTML\u额外\u文件
,LAYOUT\u文件
,因此对于测试,请禁用它们并从那里开始工作。思路不错。事实上,我的HTML\u EXTRA\u样式表
包含了CSStable{white space:pre-wrap!important;}
,这导致了问题。
/**
* - foo
* - bar
* - wah
* @exception myError
* - foo
* - bar
* - wah
*/
void myFunc();
/**
* - foo
* - bar
* - wah
*
* @exception myError
* - foo
* - bar
* - wah
*/
void myFunc();
~