> (1) your indents are not completely according to the coding standard: > usually the doxygen comments are also indented, and the new
Oh - OK, I didn't know that. > fl_gc code > looks as if it has indents of 4. Ah, sorry, that'll be wrong tab settings on my editor I suspect... > (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). OK - I'll try looking at a few more examples and see if I can match the style better. > (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 ... This sounds like a good idea - again, I'll try and understand (then copy) some of the existing examples. > (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. OK - I just added a /see to the "short" version, but it makes sense to point in both directions. Also - would it be worthwhile pointing to the similar-but-different fl_measure (and perhaps fl_width, fl_height) too? SELEX Sensors and Airborne Systems Limited Registered Office: Sigma House, Christopher Martin Road, Basildon, Essex SS14 3EL A company registered in England & Wales. Company no. 02426132 ******************************************************************** This email and any attachments are confidential to the intended recipient and may also be privileged. If you are not the intended recipient please delete it from your system and notify the sender. You should not copy it or use it for any purpose nor disclose or distribute its contents to any other person. ******************************************************************** _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
