> Author: engelsman
> Date: 2008-10-07 14:07:12 -0700 (Tue, 07 Oct 2008)
> New Revision: 6392
> Log:
> doxygen comments for undocumented drawing, clipping and color functions
>
> added comments in fl_draw.H, fl_color.cxx and fl_rect.cxx so that the
> links within drawing.dox can be simplified to allow LaTeX/PDF docs too.

The current drawing.dox provides a function reference/tutorial by using
a lot of function signatures as HTML H4 headers with embedded anchor
names that are linked to from elsewhere. For example, there are full
HTML links to Fl_Widget::draw() that point to the named entry on the
drawing.dox page.

If we follow the doxygen approach, we would simply remove the full HTML
links, and just leave 'Fl_Widget::draw()' and let doxygen fill in the
details. But then we don't get what we had before. We get a nice link
to the Fl_Widget::draw() method on the Fl_Widget class reference page,
and not into the drawing.dox page. The same will hold true for a lot of
the links within the user manual that currently point in-page rather
than to the class reference.

How should we proceed? Keep the current in-page links and add explicit
links at the end of the paragraph to Reference Page: Fl_Widget::draw()?

D.
_______________________________________________
fltk-dev mailing list
fltk-dev@easysw.com
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to