>> This problem was already discussed during the "great doxification"
>> at the start of last year. Some of these are commented so that they
>> don't get removed by mistake, but not all.
>>
>> fl_draw.H:
>> FL_EXPORT void fl_rectf(int x,int y,int w,int h,uchar r,uchar g,uchar b);
>> /* note: doxygen comment here to avoid triplication in os-speciic files */
> Thanks Duncan for this information I was not aware of.
> Coud you, please, summarize what was the outcome of this discussion,
> or give me pointers to find it ?
I'm afraid that's easier said than done because it spanned several
discussion threads in fltk.development over more than six months.
I think "Doxygenating sources for fltk 1.3 ?" in September 2008 was
one of the first.
There were arguments for and against limiting docygen comments to
either the .H header files or the .cxx source files but in the end
it was decided that the comment should reside with the implementation.
So if you have an inline function in the .H file, the comment goes
there, but otherwise the comment should be in the .cxx file. Where
this falls down is with routines that have multiple implementations
for the different platforms, so those are documented in the .H files.
I had thought that there were guidelines for doxygen comments under
http://www.fltk.org/cmp.php#CODING_STANDARDS or
http://www.fltk.org/doc-1.3/index.html
but it looks like I was mistaken (or the second was tidied up)
You might want to look at Greg's summary of the discussions under:
http://docs.google.com/Doc?id=dgn42tzv_0fsbjmjgp
I had planned to add something like this to the Developer Information
chapter (see links above) but I ran out of steam and time...
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
