NOTE: I documented this extra usage of single line doxygen commenting
that is prevalent in the FL/*.H files:

     int my_variable1_;   /**< A brief description of the member/variable. */
     int my_variable2_;   ///< A brief description of member/variable

..added that last line. I count 632 instances in FL/*.H, so it seemed
appropriate to document it. If there's objections, I can retract.

It seemed clear the reasoning for the former is its a must for pure C files,
and the reasoning for the latter is it's preferred usage in C++ to avoid
accidental run-on comments and for brevity.
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to