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
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
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
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
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
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
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
29c1972a6a
documentation/drawing.dox: Fixed that ¸ and ü encoding problem
...
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-19 07:23:19 +00:00
b670807ce0
Fixed Copyright date
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6304 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-19 00:17:01 +00:00
04d1788523
Initial and very thin unicode and utf-8 chapter.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6303 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 21:59:52 +00:00
4e8e8b9f02
More Doxygen comment support for Fluid.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6302 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 21:11:28 +00:00
f3ae3c705b
Fixing table on index page a little.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6301 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-18 20:13:10 +00:00
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
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
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
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
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
4bbafadc4f
Doxygen documentation: started to exclude few unnecessary files.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6293 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 23:26:50 +00:00
c232e9822d
This is a stab at supporting Doxygen comments from withing Fluid. Just 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-17 22:43:15 +00:00
d71cd6ec73
fixed missing <br> after dl,dt,dd modification.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6290 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 22:36:21 +00:00
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
74cbd55745
Another bunch of doxygen updates: *.dox. Fixed links and many html tags.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6287 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 21:13:03 +00:00
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
eed2315487
IMAGE_PATH correction (missed, when moved to the documentation dir)
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6285 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 20:06:34 +00:00
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
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
0dfa2ab08f
Moved Doxyfile from the root dir to documentation dir, as announced.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6280 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 11:17:57 +00:00
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
4faea14c54
doxygen: fixed typos and code examples (html quotes and \ escape sequences)
...
in tutorials
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6278 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 10:29:00 +00:00
82d47bd253
Added cairo todo list for keeping in one place related implementation guidelines.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6277 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 09:29:27 +00:00
9e2f9c5b3a
fixed typo in comments
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6276 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 09:18:52 +00:00
e81b075ab9
added a TODO in next batch section. add your own suggestions that would 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-17 08:46:43 +00:00
ec13e9a02d
Added forgotten documentation/development.dox file.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6274 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-17 08:28:08 +00:00
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
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
915d310a70
added doxygen comments for fl_color_chooser() function.
...
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-16 22:25:07 +00:00
bbc50aa689
Update my core developer state officially to 1.3 as confirmed with the team.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6268 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16 17:08:35 +00:00
889b4f3ac7
Added Duncan Gibson to CREDITS, and updated FLTK version in this file.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6267 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-16 08:39:22 +00:00
b1cc47a4b3
updated the doxygen todo file list.
...
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-16 07:47:20 +00:00
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
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
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
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
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
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
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
c975ec6dca
fixed broken links by adding double quotes, where appropriate.
...
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-15 16:42:50 +00:00
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
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
730dc6367d
Ah Unicode! Using the correct UTF8 glyphs for OS X menu shortcuts.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6253 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-15 11:41:39 +00:00
engelsman