在简短描述中加点

Question

我得到了这个示例代码。我想在我的简短评论中加一个点。

const int myVar = 1;   //!< Doxygen very long brief\.
                       //!  Brief sentence two.

我按照 doxygen 手册中的说明转义了点。这是行不通的。第一行很简短，第二行很详细。这是一个错误吗？

注意：MULTILINE_CPP_IS_BRIEF并且QT_AUTOBRIEF是YES！我使用最新版本（1.8.9.1）。

Answer 1

doxygen手册说

\n\n

\n

如果启用此选项并希望在句子中间放置一个点而不结束它，则应在其后放置一个反斜杠和一个空格。

\n

\n\n

您的反斜杠位于点的错误一侧，并且手册必须按字面意思理解，这意味着反斜杠后面需要空格。

\n\n

以下内容应该有效（没有花括号部分）：

\n\n

const int myVar = 1;   //!< Doxygen very long brief.\\ {\xe2\x86\x90 SPACE here!}\n                       //!  Brief sentence two.\n

\n