Fabien Costantini
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
Matthias Melcher
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
Fabien Costantini
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
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
Albrecht Schlosser
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
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
Albrecht Schlosser
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
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
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
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
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
Fabien Costantini
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
Albrecht Schlosser
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
Fabien Costantini
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
Albrecht Schlosser
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
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
engelsman
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
Fabien Costantini
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
Albrecht Schlosser
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
Albrecht Schlosser
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
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
Albrecht Schlosser
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
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
Matthias Melcher
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
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
Albrecht Schlosser
e760e8a6e7
updated index page with correct link to class Fl_Pixmap
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6246 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 22:03:41 +00:00
Albrecht Schlosser
de6f468b51
Edited basic chapters to be more doxygen-friendly, added \image html
...
statements.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6245 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 21:58:12 +00:00
Fabien Costantini
7f544a0cf9
updating doxygen todo file list for reserving WP7 and WP8
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6244 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 20:10:58 +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
Matthias Melcher
f49e2a7af5
Horribly hacked together Unicode keyboard support for OS X. But although this needs a lot of fixing and cleaning, we can now at least enter characters outside of the stricly ASCII range again.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6242 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 19:09:13 +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
806dd6bbdc
Reserved WP6 as well to finish with the Fl_image tree. Removed used files from WP4
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6240 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 16:45:51 +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
Fabien Costantini
bb682d955f
updated WP3 with the proper name, sorry.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6237 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 13:09:24 +00:00
Fabien Costantini
f42614b623
updated WP in progress list + file list, put Alvin in WP3, registered for WP4...
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6236 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 13:07:28 +00:00
Fabien Costantini
58548b781d
Doxygen Documentation WP2 done.
...
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6235 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 12:45:42 +00:00
Albrecht Schlosser
8bc9d467ef
Saving an improved version of FL/Enumerations.H and related files.
...
Still working on FL/Enumerations.H, though.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6234 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-14 11:15:17 +00:00