Ian MacArthur wrote: > Well - I've tried to add the comments as outlined... Here's hoping. > > Comments, advice, feedback welcome...
Looks good, thanks. You asked for comments, here are some minor comments from me: (1) your indents are not completely according to the coding standard: usually the doxygen comments are also indented, and the new fl_gc code looks as if it has indents of 4. (2) When we did the doxygenation of all comments, we also started changing the wording from, e.g. "Draw a circle..." to "Draws a circle...", or "Determines the minimum ...", but this has not (yet) been done everywhere. IMHO it would be good to have it consistent everywhere (with exceptions, where not applicable). (3) If you want to go one step further, then the first argument (const char *) should also get a name, e.g. "str", and you can describe the arguments with their intents, like: \param[in] str the string that is to be measured \param[out] dx the offset ... (4) And finally, you could also add a \see ... statement to the second form with the long description to point to the other form with counter, just to show that there is another form, if someone happens to find the long description first. But that's all optional... :-) Albrecht _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
