MacArthur, Ian (SELEX GALILEO, UK) wrote:
> Indeed - I can write the words, and generate a screenshot, but have no
> idea how to get them into the docs...

        I don't know doxygen's format either, but I figure maybe
        you can look at the comments for a function that has more
        fleshed out docs, and use similar comment style that it does.

> Indeed, the test program attached to the STR might even be added to the
> test folder, if we wanted to go that far?

        The small bit of text you had in the STR helps a lot, eg:

----
Usage: given a string "txt" drawn like this:

    fl_draw(tst, x, y);

we measure it like this:

    fl_text_extents(tst, dx, dy, wo, ho);

then the bounding box can be drawn:

    fl_rect(x+dx, y+dy, wo, ho);

note the dx, dy values hold the offset of the glyphs from the draw origin.
----

        That small bit is really quite useful in understanding what
        the function does, and its intended usage.
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to