变量后Doxygen多行注释

时间:2016-04-05 16:12:28

标签: c++ doxygen

我已经记录了一个带有doxygen语法的结构。

//! This struct contains some info
typedef struct myInfo
{
    int variable1;  //!< This is a very long text about my variable. This
                    //!< is a very long text about my variable.
} myInfo;

当我生成html / chm输出时,变量描述包含一个&#34;&lt;&#34;:&#34;这是一个关于我变量的非常长的文本。这个&lt;关于我的变量是一个很长的文本。&#34;

我使用当前的doxygen 1.8.11并设置了MULTILINE_CPP_IS_BRIEF = NO。

根据doxygen homepage(参见&#34;在成员和#34之后放置文档;)这应该有用,还是我错过了什么?

1 个答案:

答案 0 :(得分:1)

试试这个:

//! This struct contains some info
typedef struct myInfo
{
    int variable1;  /**< This is a very long text about my variable. This
                         is a very long text about my variable.*/
} myInfo;

然后你会得到一个非常“非常长”的文字。

如果您想要多行注释,请在每行的末尾添加\n