避免氧气输出断线 [英] Avoid line break in doxygen output

问题描述

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

I just realized that I can write part of the doxygen documentation inside the method implementation, which seems to be a very good way to have an accurate documentation!

一个令我困扰的一点是，我希望在多行上写句子时避免换行：

One little thing that bother me is that I would like to avoid line breaking when writing a sentence on multiple line:

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

这将生成3个不同的行，但我希望坚持下去。
有什么想法吗？

This would generate 3 differents lines but I would like it to stick it on one. Any idea?

推荐答案

您所要求的是不可能的，但是如果您想要这样详细的实现注释，读者可能也希望看到代码，因此在这种情况下，我建议使用普通的 // 注释并启用 INLINE_SOURCES 在配置文件中。

What you ask for is not possible, but if you want such detailed implementation comments, the reader probably wants to see the code as well, so in that case I suggest to use normal // comments and enable INLINE_SOURCES in the configuration file.

这篇关于避免氧气输出断线的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！