imacarthur wrote:
>
> On 10 Feb 2009, at 20:07, Albrecht Schlosser wrote:
>> In this special case however I'm not sure _where_ to put the docs: They
>> should be there, where the implementation is: inline methods in the
>> header file, other methods in the .cxx file. But here we have three
>> different implementations in the platform-specific files. IMHO it would
>> be best to put the docs in the header file in this case.
>
> So... I am uncertain about how to do this. I think I need to edit the
> file fl_draw.H, and there, before (which instance of?)
> fl_text_extents(), and presumably after the existing one-liner
> description, which I think I need to keep,
Yes, the first line constitutes the short text an must end with a full
stop ("."). After this, a blank line is optional.
> I would like to insert the
> following text:
>
> --
> Usage: given a string "txt" drawn using fl_draw(txt, x, y) you would
> determine its pixel extents on the display using fl_text_extents(txt,
> dx, dy, wo, ho) such that a bounding box that exactly fits around the
> text could be drawn with fl_rect(x+dx, y+dy, wo, ho).
> Note the dx, dy values hold the offset of the first "colored in" pixel
> of the string, from the draw origin.
> --
>
> Is it enough to just place this in a block comment that commences with
> /** ?
Yes, right after the short description, but within the same comment block.
> Is there some way I can make the one description be attached to both
> variants of fl_text_extents?
I'm not aware of such a method. The usual way is to write
\see fl_text_extents(<add arguments here>)
at the end of the docs (maybe directly below the short description).
> I know there are folk out there who are far better at doxygen than me,
> so advice is very wlecome!
I'm certainly not a doxygen specialist, but this is maybe enough. There
are also some text formatting options like \a (before a function's
argument in the text, \b for bold, \e for emphasize (italic), or a
combination like \e \b bold_and_italic.
Albrecht
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev
