2014-02-24 74 views
1

我刚刚意识到我可以在方法实现中编写部分doxygen文档,这似乎是一个非常好的方法来获得准确的文档!在doxygen输出中避免换行

打扰我的是,我想避免写在多行句子时断行一个小东西:

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

这将产生3个型动物行,但我想它贴在一个。 有什么想法?

回答

2

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

+0

我很高兴有这个伟大的工具的首席开发人员的答案!感谢:-) –

+0

完全不同的问题:我最近问了github支持,他们是否有计划在他们的平台中更好地集成代码文档,并且他们对此感兴趣。你不觉得这个想法有什么好做的吗? –