Commit Graph

519 Commits

Author SHA1 Message Date
Albrecht Schlosser
98c794fee9 added svn properties and fixed some documentation typos.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6361 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01 15:28:41 +00:00
engelsman
9c789b0e69 doxygen comments for undocumented features of Fl_File_Chooser
- needed to use new doxygen comment feature in fluid to provide comments for
  the various static const char* member variables (eg add_favorites_label).
  I had not been able to work out how to add the comments "out-of-code" in
  src/Fl_File_Chooser2.cxx without getting unpredictable end-results.

- needed to add doxygen comments for newButton and previewButton to the
  "out-of-code" comments in src/Fl_File_Chooser2.cxx because the new doxygen
  comment feature in fluid doesn't extend to widget member variables :-(

- added some missing "out-of-code" comments about customization/copying.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6358 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-30 22:22:49 +00:00
Albrecht Schlosser
acbb5af54b doxygen docs for some missing Fl_Group methods, updated Fl::focus().
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6351 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-28 22:25:23 +00:00
Fabien Costantini
ffad932289 + Cairo branch merged after successful testing on Mac OS X 10.5.4, Linux Ubuntu 8.04,Windows XPSP2.
This integration is minimum as discussed, in particular it does not feature any fltk cairo drawing substitution
  as in fltk2.
  Still it provides all the fundations to go further even in next 1.4 ... 
  By default *no* cairo features are implemented nor linked, it can only be activated by --enable-cairo
  whose default is false.
  Please visit the README.cairo for complete description.

+ fixed UTF8 compilation pb on linux ubuntu

+ minor comments fixes on the fly



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6350 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-25 18:26:33 +00:00
engelsman
f9dc24a096 doxygen comments for undocumented features of Fl_Double_Window
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6338 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 18:55:58 +00:00
engelsman
efd1647a25 doxygen comments for undocumented features of Fl_Dial, Fl_Counter
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6334 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 14:40:31 +00:00
engelsman
31ad4d23cf added #ifndef FL_DOXYGEN around cb_item struct, to hide it from doxygen
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6332 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 13:24:00 +00:00
engelsman
a4b0ac592e doxygen comments for undocumented features of Fl_Color_Browser
added comment for mode() and enum {M_RGB, ...} but now I can't find the
latter on the genrated pages. What have I done wrong?

Also added #ifndef FL_DOXYGEN around the Flcc_* helper classes so they
won't appear in the docs, or cause undocumented warnings from doxygen.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6331 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 13:20:12 +00:00
engelsman
4bc22ed15d doxygen comments for undocumented features of Fl_Clock, Fl_Check_Browser
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6327 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 08:00:32 +00:00
Albrecht Schlosser
fb343ffdf6 More doxygen updates for Fl_Text_Buffer. Also changed some argument
names from "char *s" to "char *text" to be in sync with the docs.

Caution: If there will be name conflicts with Fl_Text_buffer::text(),
then this can at least be fixed easier, because searching for "text"
is better than for "s". I remember that some argument names x,y,w,h
have been changed to uppercase, because of conflicts with x(), etc.
with ... valgrind (?) or maybe some compilers ?

I did this deliberately, because changing the headers and doxygen docs
to "s" instead of "text" appeared to be not feasible.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6326 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 01:46:27 +00:00
Albrecht Schlosser
a829ed2bd5 documented one missing remove() method.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6325 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 00:35:54 +00:00
Albrecht Schlosser
9c187dfcac fixed comment change (-r 6321): made the doxygen comment of this
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
2008-09-20 23:51:49 +00:00
Fabien Costantini
b25bd5f5eb Commented out the unimplemented method handle(int, int, int, int, int).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6321 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-20 22:59:39 +00:00
Albrecht Schlosser
b804e1f3ab Fixed some typos and links and added a section about document structure
and some more to development.dox.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6320 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-20 22:46:24 +00:00
engelsman
fd407c7775 doxygen comments for undocumented features in Fl_Browser_, Fl_Button, Fl_Chart.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6319 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-20 21:04:28 +00:00
engelsman
f5a1576d7c added doxygen comments for undocumented methods of Fl_Bitmap and Fl_Browser
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-20 14:29:29 +00:00
engelsman
40a156aa94 Simplified the doxygen comment strategy for fl_color_command()
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-19 20:56:19 +00:00
Matthias Melcher
28dacd9509 Moving simple type definitions into their own header file, so we can create 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-19 18:49:00 +00:00
Matthias Melcher
e8f467b9e3 Updating fl_utf8.h references. Fixing copyright date in .fl files.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6311 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 17:40:20 +00:00
Matthias Melcher
c7453106b9 Renameing C header for utf8 utilities from C++ extension .H to .h (via temporary file, part two)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6310 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 17:21:43 +00:00
Matthias Melcher
bc3bd9a680 Renameing C header for utf8 utilities from C++ extension .H to .h (via temporary file)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6309 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 17:21:12 +00:00
Fabien Costantini
afd1767241 fixed a glut compilation pb.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6300 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 19:35:55 +00:00
Fabien Costantini
e8478458bf Doxygen documentation: Fixed most important warnings for the Fl_Widget, 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-18 19:09:34 +00:00
Fabien Costantini
d75b9717c7 Doxygen documentation: added groups to Fl, now appearing in modules. I don't 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-18 13:20:25 +00:00
Fabien Costantini
72ac77216d Doxygen documentation
+ 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-18 10:34:22 +00:00
Fabien Costantini
dcb87bede1 Doxygen documentation: completed Fl_Gl_Window.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6294 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 00:15:35 +00:00
Fabien Costantini
2be88792b3 Doxygen documentation: fixed all ambiguous methods signatures, fixed 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-17 22:25:45 +00:00
Fabien Costantini
a2eaf60572 Doxygen documentation:
+ 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-17 20:30:37 +00:00
Fabien Costantini
3787be9b6e Doxygen documentation: replace all occurences in comments of " by a 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-17 15:44:43 +00:00
Albrecht Schlosser
b4a5023949 Last minor amendment for FL/Fl_Browser.H (doxygen formatting).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6281 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 11:26:37 +00:00
Albrecht Schlosser
5cd6da0ae4 Fixed bad '\' escape sequences (removed "unknown command" warnings).
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-17 11:08:59 +00:00
Albrecht Schlosser
6f639ea8d8 Added Appendix "Developer Information" for doxygen documentation info
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-17 08:23:24 +00:00
Fabien Costantini
f70e81134b Doxygen documentation: Fl_Widget: correcting some typos, adding a short '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-17 07:56:15 +00:00
Fabien Costantini
ae697b80b2 Doxygen documentation : took the opportunity to update copyright info as we 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-16 07:26:22 +00:00
Albrecht Schlosser
e20eeb6541 applied Duncan Gibson's documentation patch (WP3).
Docs look good, compiles okay.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6264 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16 06:49:08 +00:00
Albrecht Schlosser
5da1c0f71f Added more comments to FL/Enumerations.h,
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-15 22:55:40 +00:00
Fabien Costantini
e6652d845a Doxygen documentation increment 2: adding more classes, comments not 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-15 20:56:17 +00:00
Fabien Costantini
a99524ef2d Doxygen documentation. Completed Fl class, added a todo related to recent Fl 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-15 19:21:20 +00:00
Fabien Costantini
527351b702 Doxygen documentation. Fixed some erroneous image html params.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6259 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 18:01:19 +00:00
Fabien Costantini
d55dfeb5e9 Doxygen documentation. Fixed somes typos and also H4 remanent misplaced tags and comments.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6258 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 17:46:42 +00:00
Fabien Costantini
b8955a9ced Doxygen documentation WP11 Done!
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6255 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 16:39:05 +00:00
Fabien Costantini
09f3094aef Doxygen documentation WP10 Done. Reserved WP11.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 12:46:49 +00:00
Fabien Costantini
a35a533368 Doxygen documentation Fixed broken Fl_Scroll.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6252 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 11:14:22 +00:00
Fabien Costantini
8701883e54 Doxygen documentation WP9 Done.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6251 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 11:10:51 +00:00
Fabien Costantini
b9ca133376 Doxygen documentation WP8 Done. Reserved WP9, WP10. Will now check WP3 from engelsman and integrates it.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6250 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 08:41:54 +00:00
Fabien Costantini
fdcfef214e Doxygen documentation WP7 Done. Fl_Menu_Item was a real pain to doxyfy.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6248 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 00:27:28 +00:00
Fabien Costantini
6645d3cb6a Doxygen Documentation WP6 Done, Also completed the documentation of Help_View, Help_Dialog and cleaned up Preferences from ugly stars in comments and also removed redundant get/set text from methods doc. In this increment, we don't bother with the old dox format (comments in header). We have better things to do with our time (like about 40 mores files to doxyfy :-).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6243 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 20:00:03 +00:00
Fabien Costantini
7ddd3b8c50 Doxygen Documentation WP5 Done, WP6 half finished so that all Fl_Image class hierarchy is up-to-date. Also completed the documentation of the useful Fl_Shared_Image.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6241 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 18:19:41 +00:00
Fabien Costantini
ce4d0fd5d8 Doxygen Documentation WP4 Done. Has all documentation content but should be completed in increment 2. Registered for WP5.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6239 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 15:45:27 +00:00
Albrecht Schlosser
7f4e2867e8 Yet another update for FL/Enumerations.H.
Added more documentation and tried some grouping.


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6238 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 13:13:24 +00:00