Albrecht Schlosser wrote:
> [..]
> It would be nice if you could also move the docs to Fl_Tooltip.cxx, where
> they should be. Thanks

        Done.

        In the beginning, wasn't sure where to put the docs,
        because Fl_Widget's docs seemed to follow its own rules.

        I assumed this was due to the fact many of Fl_Widget's methods
        are not implemented in Fl_Widget.{cxx,H} files, but there was
        a desire to keep the docs in one place.

        The general rule 'docs go where the implementation is' seems
        not be followed for many of Fl_Widget's methods, where docs
        are in the .H, but the code is implemented elsewhere, eg:

                label(), copy_label(),
                activate(), deactivate(),
                take_focus(),
                default_callback(), do_callback(),
                redraw(), redraw_label(),
                damage(uchar), damage(char,int,int,int,int)

        ~Fl_Widget() has docs in BOTH files (.H and .cxx).
        doxygen seems to merge them both in an odd way.
        (This should be fixed for sure)

        It certainly makes more sense to keep the docs
        where the code implementation is, so that one can catch
        discrepancies between the docs and what the code actually does.

        If you want, I can clean up all the above, moving the docs
        from Fl_Widget.H to where the code is implemented.

        Even if the docs are in different files, doxygen seems good
        about rounding them up into the proper documents.
_______________________________________________
fltk-dev mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-dev

Reply via email to