Duncan Gibson wrote:
> I'm not an expert on the internals of fltk, but I would quite like
> to contribute to 1.3 by having a go at the initial doxygenation of
> the source code.
Yes, same here. And maybe more than only initial ...
> Does anyone have any tips/guidelines apart from the Coding Standards
> in the Configuration Management Plan document?
I think that there should be a common style ("documentation standard"),
how to use keywords like \todo, \see. Or how to write longer comments.
/** There are comments like this in Fl_Widget.H. I don't like
* the idea of indenting comments with " * " ...
*/
... because this would make rewriting and cut'n'paste from the previous
docs more difficult. Although this may work with some editors...
I also wondered, how to document private methods (or not at all ?).
Albrecht
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
