在简要说明中加点

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

那我觉得你一定要显式，使用\brief命令。 doxygen 文档 Documenting the code 说

For the brief description there are also several possibilities:

1.One could use the \brief command with one of the above comment blocks. This command ends at the end of a paragraph, so the detailed description follows after an empty line.

Here is an example:

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

您可能还需要将 JAVADOC_AUTOBRIEF 设置为否。如果您仍然有问题，请将评论放在 myVar.

之前而不是之后，看看您是否得到了想要的东西

希望对您有所帮助！

Answer 2

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.

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

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

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

Answer 3

反斜杠似乎在错误的一边。这是正确方法的另一个示例：

const int myInt = 2;   //!< Brief description (e.g.\ using only a few words). Details follow.

在简要说明中加点

Put dot in brief description

doxygen