doxygen - 在简要说明中加点

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 manual说

If you enable this option and want to put a dot in the middle of a sentence without ending it, you should put a backslash and a space after it.

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

以下应该有效(没有花括号部分):

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