I'm using "\see Related methods xxx,yyy.." to 'group' like-kind methods
together.
I'm doing checks on the docs in "passes" on Fl_Browser:
o Standardize comment style where it varies
o Make sure variable names are descriptive (l -> item, p->pos)
o Make sure methods with parameters mention them with \p and \param[in]
o Make sure methods with non-obvious return values include \returns xxx
o Make sure the 'brief' line is OK to stand on its own in the index
(ie. is 'short enough' and 'descriptive enough' without being
dependent
on the sentences that follow it)
o Make sure like kind methods are grouped with \see Related methods
xxx,yyy
o Spell check the comments (in vim ":set spell")
o Add example code fragments where necessary
o Check the final doxygen output for errors/unclear commenting
I'm surprised how long it takes to do this, even when the docs are 90% there..
it's more work than I thought!
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
