Вопрос

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...
    ...
}

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

Это было полезно?

Решение

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.

Лицензировано под: CC-BY-SA с атрибуция
Не связан с StackOverflow
scroll top