Make sure you set INHERIT_DOCS = NO in the doxygen control file. This stops it from repeating the Fl_Widget description in all the subclasses and helps a lot. In particular because most of the description of the virtual functions is not how to *use* them, but rather how to *override* them, and probably very confusing and/or uninteresting to somebody trying to use the Button.
matthiasm wrote: > > Great job with the Doxygen comments so far! Thank you. > > On 14.09.2008, at 16:55, Duncan Gibson wrote: > >> 1. the "no html" rule. Unfortunately doxygen's \c only sets the next >> word to a constant width (code) font, and text in \code and \endcode >> pairs ends up in its own boxed paragraph. To format multiple words >> inline using a constant width font either requires one \c per word. >> This is fugly for code such as \c FL_ALT \c | \c (FL_F \c + \c10) >> which can be handled much more readably within <tt> </tt> >> pairs. > > Good news! I looked through the Doxygen manual again and fond this page > which listst all the html commands that can be used in Doxygen comments > and will be translated correctly into pdf, etc. . Whee! > > <http://www.stack.nl/~dimitri/doxygen/htmlcmds.html> > >> 2. Fl_Button.H has: >> Fl_Button(int,int,int,int,const char* =0) >> Fl_Button.cxx has: >> Fl_Button(int X, int Y, int W, int H, const char* l) >> >> If I place the doxy-comment in Fl_Button.cxx, the .H form is shown >> in the generated file. Should I then re-include the elided parameter >> names in the .H file? > > I don't mind compact header file, but I found the laziness of not > repeating the names of arguments in the header to be a mistake. Smart > text editors find the declaration and give help while typing. Leaving > out the argument names makes this feature almost useless. Now Doygen > seems to backfire as well. > > I am afraid the Right Way to do this is to retype the arguments in the > header files. > >> 3. Fl_Button.html has a description for the ~Fl_Button() descructor, >> which is an implicit destructor that is not declared in .H or .cxx >> I intend to leave this out. C++ programmers should grok destructors. > > > There should not be any additional information in the ~Fl_Button > documentation than in ~Fl_Widget. If there is, that info should be in > ~Fl_Widget. Doxygen will generate a link there form "Fl_Button->all > memebers". > > Matthias > > ---- > http://robowerk.com/ > > _______________________________________________ fltk-dev mailing list [email protected] http://lists.easysw.com/mailman/listinfo/fltk-dev
