我已经用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;
Run Code Online (Sandbox Code Playgroud)
当我生成html / chm输出时,变量描述包含一个“ <”:“这是有关我的变量的很长的文本。这<是有关我的变量的很长的文本。”
我正在使用当前的doxygen 1.8.11,并且已将MULTILINE_CPP_IS_BRIEF设置为NO。
根据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;
Run Code Online (Sandbox Code Playgroud)
然后你会得到一个真正“很长”的文本。
如果需要多行注释,请\n在每行末尾放置一个。