summaryrefslogtreecommitdiff
AgeCommit message (Collapse)Author
2008-09-20added doxygen comments for undocumented methods of Fl_Bitmap and Fl_Browserengelsman
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
2008-09-19Simplified the doxygen comment strategy for fl_color_command()engelsman
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
2008-09-19Moving simple type definitions into their own header file, so we can create ↵Matthias Melcher
a 'C' header and dont need to include the 'C++' Enumerations.H git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6312 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19Updating fl_utf8.h references. Fixing copyright date in .fl files.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6311 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19Renameing C header for utf8 utilities from C++ extension .H to .h (via ↵Matthias Melcher
temporary file, part two) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6310 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19Renameing C header for utf8 utilities from C++ extension .H to .h (via ↵Matthias Melcher
temporary file) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6309 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19documentation/drawing.dox: Fixed that ¸ and ü encoding problemAlbrecht Schlosser
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
2008-09-19Fixed Copyright dateMatthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6304 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Initial and very thin unicode and utf-8 chapter.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6303 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18More Doxygen comment support for Fluid.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6302 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Fixing table on index page a little.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6301 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18fixed a glut compilation pb.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6300 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Doxygen documentation: Fixed most important warnings for the Fl_Widget, ↵Fabien Costantini
Fl_Window, Fl_Valuator classes that should be now a 100% documented. For the rest I drastically reduced the undocumented APIs, but many others (less important) remains. It looks and feels pretty good now :-) git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6299 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Doxygen documentation: added groups to Fl, now appearing in modules. I don't ↵Fabien Costantini
like to see an isolated fl_color_chooser function instead it should be attached to a group called Common Dialogs with all fltk ask color file directory predefined dialogs... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6298 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18Doxygen documentationFabien Costantini
+ 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
2008-09-18Doxygen documentation: completed Fl_Gl_Window.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6294 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation: started to exclude few unnecessary files.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6293 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17This is a stab at supporting Doxygen comments from withing Fluid. Just ↵Matthias Melcher
double click on a function, class, or declaration and you will be able to add a comment. Comments welcome. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6291 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17fixed missing <br> after dl,dt,dd modification.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6290 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation: fixed all ambiguous methods signatures, fixed ↵Fabien Costantini
erroneous path test into ../test since the doxyfile move, fixed all intro dl,dt,dd related tags warnings in intro.dox . git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6289 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Another bunch of doxygen updates: *.dox. Fixed links and many html tags.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6287 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation:Fabien Costantini
+ 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
2008-09-17IMAGE_PATH correction (missed, when moved to the documentation dir)Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6285 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Doxygen documentation: replace all occurences in comments of &quot; by a ↵Fabien Costantini
quote char. Temporarily set warn_if_undocumented to NO until we correct more severe messages. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6283 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Last minor amendment for FL/Fl_Browser.H (doxygen formatting).Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6281 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Moved Doxyfile from the root dir to documentation dir, as announced.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6280 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Fixed bad '\' escape sequences (removed "unknown command" warnings).Albrecht Schlosser
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
2008-09-17doxygen: fixed typos and code examples (html quotes and \ escape sequences)Albrecht Schlosser
in tutorials git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6278 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Added cairo todo list for keeping in one place related implementation ↵Fabien Costantini
guidelines. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6277 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17fixed typo in commentsAlbrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6276 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17added a TODO in next batch section. add your own suggestions that would ↵Fabien Costantini
affect lot of files in one shot. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6275 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Added forgotten documentation/development.dox file.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6274 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17Added Appendix "Developer Information" for doxygen documentation infoAlbrecht Schlosser
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
2008-09-17Doxygen documentation: Fl_Widget: correcting some typos, adding a short ↵Fabien Costantini
'good practice' paragraph in handle method to help the beginners learning curve, inspired by what i read in the general forum. Also starting an effort to normalize the comments a get/set method comment should always use get instead of return to avoid confusion with the return code. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6272 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16added doxygen comments for fl_color_chooser() function.engelsman
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
2008-09-16Update my core developer state officially to 1.3 as confirmed with the team. Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6268 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16Added Duncan Gibson to CREDITS, and updated FLTK version in this file.Albrecht Schlosser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6267 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16updated the doxygen todo file list.Albrecht Schlosser
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
2008-09-16Doxygen documentation : took the opportunity to update copyright info as we ↵Fabien Costantini
modified already in batch almost all sources, added also a fil doxygen command to class headers to harmonize with original matt Fl_Widget dox. format. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6265 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16applied Duncan Gibson's documentation patch (WP3).Albrecht Schlosser
Docs look good, compiles okay. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6264 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Added more comments to FL/Enumerations.h,Albrecht Schlosser
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
2008-09-15Doxygen documentation increment 2: adding more classes, comments not ↵Fabien Costantini
referenced in original doc. hide public enter_(), exit_() functions, made friend Fl_Widget::tooltip(), these should not appear in the public member dox. documentation. added static variables initialisation to 0 in glut for msvc platform compilers." git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6261 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation. Completed Fl class, added a todo related to recent Fl ↵Fabien Costantini
API to document. Matt?. More cosmetics have been done, replaced *all* <pre> </pre> tags by \code \endcode sequences. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6260 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation. Fixed some erroneous image html params.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6259 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation. Fixed somes typos and also H4 remanent misplaced ↵Fabien Costantini
tags and comments. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6258 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15fixed broken links by adding double quotes, where appropriate.Albrecht Schlosser
This may be a doxygen bug, but I fixed it anyway. \todo fix other links without double quotes or fix doxygen, if this is a doxygen bug. git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6256 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation WP11 Done!Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation WP10 Done. Reserved WP11.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Ah Unicode! Using the correct UTF8 glyphs for OS X menu shortcuts.Matthias Melcher
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6253 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15Doxygen documentation Fixed broken Fl_Scroll.Fabien Costantini
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6252 ea41ed52-d2ee-0310-a9c1-e6b18d33e121