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你可以通过逃避这段时间来解决这个精确的问题。但是：/// Brief description\. Brief description continued.对我不起作用。

根据这个建议，出现代替的是“逃避空间”/// Brief description.\ Brief description continued。我不相信doxygen的实际“特征”，我只是把它弄糊涂了，它忽略了错误状态。

有人可以向我确认有关\.空间用于此目的的文档不正确吗？ （如果是这样，那么参与标签的doxygen的人是否想要提交报告？）
如果\ （反斜杠空格）不是获得批准的逃避空间的方式，那么是否有背书方式？我尝试了几件不喜欢的东西......例如.。

Answer 1

我相信如果您将MULTILINE_CPP_IS_BRIEF设置为YES，然后将JAVADOC_AUTOBRIEF和QT_AUTOBRIEF都设置回NO，您将获得所需的行为

我必须为我的所有项目设置这个，因为我过度延长了。它允许我在一个＆＃34;简短的＆＃34;中写出多个句子 - 甚至跨越多行。描述没有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;

得到这样的输出：

返回此颜色的Alpha通道值，以百分比表示。值0％表示完全透明，而100％表示完全不透明。

根据Wikipedia，Alpha通道的概念最初是由Alvy Ray Smith在20世纪70年代末引入的，并在Thomas Porter和Tom Duff在1984年的一篇论文中得到了充分的发展。在存储每个像素的颜色的2D图像元素中，附加的透明度数据存储在alpha通道中......

无需转义！您可以在函数，类，命名空间或其他任何内容上使用它。整个多行简要描述甚至显示在大表中（例如，您在页面上看到列出项目中的所有名称空间）。

Answer 2

根据这个建议，似乎工作的是“逃避空间”jquery。我不相信这是Doxygen的实际“特征”

这是manual中记录的官方功能：

如果启用此选项并希望在句子中间放置一个点而不结束它，则应该在反斜杠后添加一个空格。这是一个例子：

/// Brief description.\ Brief description continued

我已为/** Brief description (e.g.\ using only a few words). Details follow. */的文档提交了一份错误报告（Bugzilla＃782373）。

从JAVADOC_AUTOBRIEF中的结束简要描述中取消句点

2 个答案: