避免在doxygen输出中断线

时间:2014-02-24 00:58:59

标签: doxygen

我刚刚意识到我可以在方法实现中编写部分doxygen文档,这似乎是获得准确文档的一种非常好的方法!

困扰我的一件小事是我想在多行上写句子时避免换行:

/// Check if the pointer is not null,
if( ptr != ) {
    /// increment it
    ptr++
    /// and perform other stupid task...
    ...
}

这将生成3个不同的行,但我希望它坚持一个。 有什么想法吗?

1 个答案:

答案 0 :(得分:2)

你要求的是不可能的,但是如果你想要这样详细的实现评论,读者可能也希望看到代码,所以在这种情况下我建议使用正常的//注释并启用{{ 1}}在配置文件中。