escaping - 抑制 JAVADOC_AUTOBRIEF 中结束简短描述中的句点

Question

JAVADOC_AUTOBRIEF设置似乎非常方便，因此可以不用写:

/// \brief Brief description.
///        Brief description continued.
///
/// Detailed description starts here.

你可以写:

/// Brief description; brief description continued.
///
/// Detailed description starts here.

然而，在我使用 ; 此处将内容合并为单个句子的地方，我希望有一个选项以某种方式阻止句点结束简短描述.

当我稍微浏览一下源代码时，我 found a suggestion你可以通过避开句点来解决这个精确的问题。但是: ///简要说明\.继续简要描述。 对我来说不起作用。

根据该建议，似乎起作用的是“转义空间”，如 ///简要描述。\继续简要描述。我不相信这是 doxygen 的实际“功能”，我只是混淆了它，它忽略了错误状态。

• 任何人都可以帮我确认文档中有关用于此目的的 \. 空间的信息不正确吗？ (如果是这样，关注此处标签的 doxygen 相关人员是否想提交相关报告？)

• 如果 \ (backslash-space) 不是一种经过批准的转义空间方法，那么是否有一种经过认可的方法？我尝试了一些它不喜欢的东西...例如.。

Answer 1

我相信如果你设置 MULTILINE_CPP_IS_BRIEF 你会得到你想要的行为为 YES，然后将 JAVADOC_AUTOBRIEF 和 QT_AUTOBRIEF 设置回 NO。

我必须为我的所有项目设置这个，因为我太冗长了。它允许我在“简短”描述中写出多个句子，甚至跨越多行，而 doxygen 不会打断我。

缺点是您必须在多行简要描述和始终多行详细描述的开头之间跳过一行。显然，这就是它知道一个何时开始另一个结束的方式。

无论如何，你现在可以写这样的东西:

/// Returns the alpha channel value of this color, represented as a percentage.
/// A value of 0% means completely transparent, while 100% means fully opaque.
/// 
/// According to [Wikipedia](https://en.wikipedia.org/wiki/Alpha_compositing),
/// the concept of an alpha channel was first introduced by Alvy Ray Smith in
/// the late 1970s, and fully developed in a 1984 paper by Thomas Porter and
/// Tom Duff. In a 2D image element, which stores a color for each pixel, the
/// additional transparency data is stored in the alpha channel...
/// @return  Returns a percentage from 0 (completely transparent) to 100 (fully opaque)
///              that indicates the color's alpha channel transparency.
/// @see SetAlpha() to set a new alpha channel value
int GetAlpha() const;

并获得如下输出:

Returns the alpha channel value of this color, represented as a percentage. A value of 0% means completely transparent, while 100% means fully opaque.

According to Wikipedia, the concept of an alpha channel was first introduced by Alvy Ray Smith in the late 1970s, and fully developed in a 1984 paper by Thomas Porter and Tom Duff. In a 2D image element, which stores a color for each pixel, the additional transparency data is stored in the alpha channel...

无需转义!您可以在函数、类、命名空间等上使用它。整个多行简短描述甚至显示在大表中(例如，就像您在列出项目中所有 namespace 的页面上看到的那样)。