I think that we discussed this before, and we did already change many occurrences, but this should probably put in the doxygen standard as well.
I don't know how to say it best, but I'm sure that Greg will find the right words... (Thanks for your Google project, BTW., I'll have a look at it when I have more time). The short description should start like a sentence with an implicit (but elided) "This method ..." at its beginning, where applicable, e.g. - "Gets the current color." - "Sets the background color." - "Returns the last item in the Fl_Browser." The old docs have sentences like "Get the current color". However, if this is not useful, other full sentences should be used, like "The constructor creates an empty Fl_Browser widget." One of the reasons is that doxygen shows the brief description when it is referenced in the docs elsewhere and the mouse hovers over the reference (link). IMHO the main point here is also to be _consistent_. At least if we change docs, we should do it consistently wherever we see/edit the short descriptions. Albrecht _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
