Much prefer the \a syntax rather than the \p syntax as it has the same look that the parameters shown in the function declaration (italic).
Should be added to the todo list how to.
Completed all other parameters applying the \a modification in this file.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6323 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
commented handle() method a normal comment. Otherwise it would
have unintentionally documented draw().
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6322 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
also replaced some html with doxygen equivalent.
note that not all comments are consistent. some are one-liners, even though
the contain [obvious?] parameters, and others have \param and \returns.
note too, that some parameter names are ambiguous and require type info,
eg line could be FL_BLINE* for whole line entry, or int for line number,
and this can make descriptions awkward (\param line line number).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6318 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Too many \defgroup, \ingroup and \relatesalso and doxygen gets confused!
Simplified down to a single \relatesalso, and moved the extra function
documentation into the class comments.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6313 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
by coding this in utf-8.
documentation/development.dox: added some more examples with links and
hidden comments.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6305 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
+ Added new \relatesalso dox command to attach fl_file_chooser(), fl_color_chooser() to their respective related classes
+ corrected copyright date and added lgpl with exceptions in preface
+ restored undocumented warnings, changed QUIET mode to yes, this way we get all warnings/errors and not the long verbose list treated files. Seems to be a bit faster to run too.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6297 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
+ Added HAVE_GL,HAVE_GL_OVERLAY to Doxyfile defines
+ many obsolete api signature causing to be igmored by doxygen have been fixed, more to come and this is good! (we are forced to refresh these api and be up-to-date to have them documented...)
+ Added a Fl_Gl_Window::draw() method that raises a Fl::fatal() message if used directly. The old doc said it was a pure virtual which is not true. one can easily create a Fl_Gl_Window created, this won't work of course but is subject to trouble.
Now the Fl_Gl_Window doxygenize beautifully and content is more accurate.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6286 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
And yes, I added some <tt> tags again, because e.g. "@." wouldn't
be very well readable in a proportional font (FL_Browser.H).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6279 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
and maybe more guidelines.
Fixed links, and replace a "\r" with "\\r".
\todo: there are more doxygen "\?" warnings to be resolved.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6273 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
By creating a doxygen group in the .cxx file with the implementation,
I've achieved a separate fl_color_chooser() module in the generated
documentation, with a Referenced by link that doesn't [yet] work.
Is there a way to also make this appear in the Fl_Color_Chooser.H page?
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6270 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Todo: remove the related files that are done from the list, especially
for those that engelsman modified.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6266 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
minor amendment for common.dox,
updated todo_filelist_doc.txt
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6262 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
