Greg Ercolano wrote: >>> I'd also be happy to start or assist in the creation of an >>> FLTK doxygen "standards" page that describes how docs should >>> appear, so that new docs follow a certain format. > > Great; I'll see if I can give it a start.
BTW, looks like there's already a bit mentioned in the FLTK coding standards already.. didn't notice that until just now.. search for "Source File Documentation" in: http://www.fltk.org/cmp.php#CODING_STANDARDS We obviously want to flesh out from there, but it's a good start. I have something, but want to hold off until I update it with stuff from today. One thing I'd add regarding code commenting; when adding doxygen docs, make sure if you're in a C oriented file, not to use C++ style comments (like ///< ). The LGPL headers at the top of the source file is probably a good indication of the file being C or C++; 1) A /* */ enclosed LGPL notice probably indicates a C file 2) A // enclosed LGPL notice surely indicates a C++ file As we found today, SGI won't compile // style comments in a file being compiled by the C compiler, and you can't always go by the filename extension being .h/.c for C files; filename.H and Fl_Export.H are actually looked at by C files. _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
