Commit Graph

3176 Commits

Author SHA1 Message Date
Albrecht Schlosser
130029372d More work on links, new navigation elements at the bottom of development.dox.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6337 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 18:25:17 +00:00
engelsman
da70ad2226 added #ifndef FL_DOXYGEN around Flcc_*::methods() to avoid warnings.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6335 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 15:29:42 +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
Albrecht Schlosser
9ce5dd8c73 Updated lots of links in text documentation.
Added missing file "tiny.gif" for html_footer.
Updated html_footer (copyright, no date/time, no line break).


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6333 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 14:06:57 +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
Albrecht Schlosser
c7921f06ad Forgotten html_footer file added.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6330 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 11:00:00 +00:00
Albrecht Schlosser
ebc93ed3f2 Added a html_footer file for display at the bottom of each doxygen page
instead of the doxygen default "Generated ... by doxygen"
(copied from FLTK 2.0).

This should be discussed, and optionally removed or modified.

Added 5 different navigation elements to the bottom of development.dox.
Please check, what you like most (if any).


git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6329 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-09-21 10:46:25 +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
Fabien Costantini
87c649e153 Corrected duplicated paragraph in previous commit.
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
2008-09-21 00:09:12 +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
Albrecht Schlosser
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
Matthias Melcher
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
Matthias Melcher
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
Matthias Melcher
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
Matthias Melcher
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
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
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 &quot; 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