escaping - Suppress periods from ending brief description in JAVADOC_AUTOBRIEF -


the javadoc_autobrief setting seems nice convenience, instead of writing:

/// \brief brief description. ///        brief description continued. /// /// detailed description starts here. 

you can write:

/// brief description; brief description continued. /// /// detailed description starts here. 

yet have used ; here merge content single sentence, have option of somehow preventing period ending brief description.

when went poke through source little, found suggestion around precise problem escaping period. however: /// brief description\. brief description continued. did not work me.

based on suggestion, appeared work instead "escaping space" /// brief description.\ brief description continued. i'm not convinced that's actual "feature" of doxygen, , confused , ignored error state.

  • can confirm me documentation incorrect \. space being used purpose? (if so, involved doxygen followed tag here want file report that?)

  • if \ (backslash-space) isn't approved way escape space, there endorsed way? tried several things didn't like... such ..

i believe behavior desire if set multiline_cpp_is_brief yes, , set both javadoc_autobrief , qt_autobrief no.

i have set of projects because excessively prolix. allows me write multiple sentences—and span multiple lines—within "brief" description without doxygen cutting me off.

the drawback must skip line between multi-line brief description , beginning of always-multi-line detailed description. obviously, that's how knows when 1 begins , ends.

anyway, can write stuff this:

/// returns alpha channel value of color, represented percentage. /// value of 0% means transparent, while 100% means opaque. ///  /// according [wikipedia](https://en.wikipedia.org/wiki/alpha_compositing), /// concept of alpha channel first introduced alvy ray smith in /// late 1970s, , developed in 1984 paper thomas porter , /// tom duff. in 2d image element, stores color each pixel, /// additional transparency data stored in alpha channel... /// @return  returns percentage 0 (completely transparent) 100 (fully opaque) ///              indicates color's alpha channel transparency. /// @see setalpha() set new alpha channel value int getalpha() const; 

and output this:

returns alpha channel value of color, represented percentage. value of 0% means transparent, while 100% means opaque.

according wikipedia, concept of alpha channel first introduced alvy ray smith in late 1970s, , developed in 1984 paper thomas porter , tom duff. in 2d image element, stores color each pixel, additional transparency data stored in alpha channel...

no escaping required! can use on functions, classes, namespaces, or whatever. entire multi-line brief description shows in big tables (e.g., see on page listing namespaces in project).


Comments

Popular posts from this blog

c++ - Delete matches in OpenCV (Keypoints and descriptors) -

java - Could not locate OpenAL library -

sorting - opencl Bitonic sort with 64 bits keys -