【问题标题】:Doxygen lists within exception tags render incorrectly异常标签中的 Doxygen 列表呈现不正确
【发布时间】:2021-06-09 23:27:01
【问题描述】:

符号主文档中的列表...

/**
 * - foo
 * - bar
 * - wah
 */

在 Doxygen 中作为要点很好地呈现:

exception 标签的 Doxygen documentation 包括:

[@exception 之后] 段落的文本没有特殊的内部结构。所有视觉增强命令都可以在段落内使用。每个异常描述都将从新行开始。 \exception 描述在遇到空行或其他分段命令时结束。

尽管“所有视觉增强命令都可以在段落内使用”,但似乎列表在exception标签内无法正确呈现,可能是由于对行尾的严格处理。

同一个列表,在 exception 标签内...

/**
 * @exception myError
 * - foo 
 * - bar 
 * - wah
 */

以奇怪的间隔呈现为项目符号:

Doxygen 有可能将列表中的每个元素解释为单独的“异常描述”,并因此用换行符分隔它们。 我怎样才能避免这种行为,使列表以与主文档中相同的方式呈现为项目符号?

我在 Ubuntu 18.04 上使用 Doxygen 1.8.13Here 是我的 doxygen 配置文件,它错误地呈现了以下 MWE:

/**
 * - foo 
 * - bar 
 * - wah
 * @exception myError
 * - foo 
 * - bar 
 * - wah
 */
void myFunc();

【问题讨论】:

  • 您使用的是哪个版本的 doxygen?请给出一个最小的、完整的例子来显示问题,因为给定的信息我无法重现该问题(使用默认设置文件并在将/* 更正为/**``). Also specify the settings that are different from the default settings (doxygen -x` 输出以用于较新的版本)
  • @albert 所以有希望!我已经用版本和 MWE 更新了我的问题

标签: documentation doxygen


【解决方案1】:

Doxygen 1.8.13 已经有点老了(2016 年 12 月),我当然建议更新到当前版本 1.9.1 但这不是问题的原因/。

提供的 Doxyfile 并不是最小的,并且包含许多与当前问题无关的项目特定内容。一个带有

的doxyfile
EXTRACT_ALL=YES
QUIET=YES

足够了。

当运行给定的输入时,我们得到:

问题是我们希望在哪里拥有单词Exceptions 和随后的列表项? 目前第一组列表项直到第二个- wuh 之后才终止,Exceptions 被视为第一个wuh 列表项的一部分,第二个foo 被视为一级列表项,因此上面显示的输出。

一种解决方案(不是@exception 之后的项目之前的额外空间,使其成为二级列表):

/**
 * - foo
 * - bar
 * - wah
 * @exception myError
 *   - foo
 *   - bar
 *   - wah
 */
void myFunc();

结果:

可能是想要的解决方案(注意@exception 之前的空行,它终止了第一个列表):

/**
 * - foo
 * - bar
 * - wah
 *
 * @exception myError
 * - foo
 * - bar
 * - wah
 */
void myFunc();
~                

结果:

(我用 1.8.13 版本运行一切)

【讨论】:

  • 您的解决方案都不能在我的系统上正确呈现;也许我的配置中有其他东西在起作用 - 如果我有先见之明知道它是哪一个,我会把它缩小到相关部分
  • 从我展示的可能性中,哪种图像/解决方案对您来说是正确的?当你用你的设置运行它时你会得到什么? (将此信息添加为问题的编辑)。正如之前在您的 Doxyfile 中提到的,我必须禁用许多系统依赖项,给出问题的好候选是 HTML_HEADERHTML_FOOTERHTML_EXTRA_STYLESHEETHTML_EXTRA_FILESLAYOUT_FILE 所以对于测试禁用这些和从那里开始工作。
  • 好主意。事实上,我的 HTML_EXTRA_STYLESHEET 包含导致问题的 CSS table{ white-space:pre-wrap !important; }
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 2011-01-12
  • 2018-01-08
  • 2017-07-13
  • 1970-01-01
  • 2015-01-27
  • 2010-09-23
  • 1970-01-01
相关资源
最近更新 更多