Commit Graph

544 Commits

Author SHA1 Message Date
Matthias Melcher
fc28028954 Updated some documentation for Fl_Preferences::getUserdataPath()
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6460 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-18 20:35:13 +00:00
Matthias Melcher
b91aec5b87 Added clarification to Fl_GL_Window mode function (STR #1945)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6459 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-18 20:01:04 +00:00
engelsman
4b48d5f84a added more minor doxygen comments for fl_draw.H and fl_line_style.cxx
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6444 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-16 20:56:43 +00:00
engelsman
065cfaadbe minor doxygen updates for fl_draw.H, fl_color.cxx and fl_vertex.cxx
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6442 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 21:38:38 +00:00
Fabien Costantini
5a71578b1b Doxygen pdf documentation: Changed pdf mime type to application/pdf. Removed all Widget class headers from file section as they already are in the class section, this saves many pages. Also disabled the referenced by/from systematic inserts for each functions as this is more a core developer documentation feature than a fltk user manual feature, also saves many pages. Didn't use the LATEX_COMPACT feature yet, not happy with its result, will comment it later.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6439 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 13:46:06 +00:00
Fabien Costantini
d272c1b43f Doxygen PDF Documentation: Added image latex tags, added missing eps corresponding images (most of them in B/W) for the widget classes.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6437 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 11:27:29 +00:00
engelsman
e08fffdfe0 copied more documentation from drawing.dox to {fl_curve,fl_vertex}.cxx
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6430 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 21:42:24 +00:00
Fabien Costantini
92051890f1 Quickdraw removal: option removed from configure, all Qd code removed from sources. Also took this opportunity to sort the ifdef clauses so that USE_X11 shows first. Also added error pragma to enforce proper target checking, thus make even less assumptions.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6423 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-13 23:10:43 +00:00
engelsman
de04c108f8 copied more doxygen comments from drawing.dox back to source code
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6421 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-13 21:42:05 +00:00
Matthias Melcher
a26d5408a1 STR 1952: Fixed first modifier key event, some minor utf8 orrections.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6416 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-13 19:26:18 +00:00
engelsman
0adc1ccdaa doxygen comments for undocumented drawing, clipping and color functions
added comments in fl_draw.H, fl_color.cxx and fl_rect.cxx so that the
links within drawing.dox can be simplified to allow LaTeX/PDF docs too.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6392 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-07 21:07:12 +00:00
Fabien Costantini
30800d35d4 STR#2052 fixed. Also added documentation to FL_File_Input explaining what events the user can handle and also an application note explaining how to avoid potential callback reentrant calls.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6386 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-05 23:10:33 +00:00
Fabien Costantini
908a2b5515 Doxygen documentation: added missing counter.gif image in Fl_Counter,Fl_Simple_Counter doc, also corrected some typos. Fl_Spinner is missing a gif file in class doc., would be nice to add a little one (could be extracted from valuators.gif)
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6385 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-05 22:51:56 +00:00
Fabien Costantini
fdeb60898e #STR2056 partial fixes : wsock API now compiles ok, but there are still all utf8 stuff that won't compile: fl_utf8.cxx, fl_set_fonts_win32.cxx won't compile yet and Fl_Preferences recent utf8 addon should be checked for Cygwin.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6375 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-04 16:35:58 +00:00
engelsman
c28c0de681 added doxygen comments for undocumented features in Fl, Fl_Gl_Window
- I see Fabien was/is? busy with Fl.H, so I submit the few changes
  I've made and hope I haven't trodden on his toes too much :-)



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6374 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-04 15:54:15 +00:00
Fabien Costantini
7fc0d4903d Corrected comment inversion in fl screen_xywh() api.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6373 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-04 15:27:12 +00:00
Fabien Costantini
bfac12dbfa Completed and corrected Fl and related Fl_Window documentation, added cross references, especially to back compatibility functions to the new ones.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6372 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-04 14:15:16 +00:00
engelsman
0eb1ac797f added doxygen comments for undocumented features of Fl_File_Icon
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6371 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-04 12:21:46 +00:00
Fabien Costantini
727b50652c Added systematically missing in out modifiers to all param doxygen statements. Added a TODO.osx file in the root describing what we have to do on the os x platform before we can pre-release 1.3
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6368 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-03 12:00:21 +00:00
Fabien Costantini
fabf5fc181 Fixed bad comments in fl_color_chooser, r g b param are in/out params and not in. Added param and return dox commands to these functions. Added a new Common Dialogs Module containing all fl_ask,fl,fl_color,fl_file dialogs. Fixed the fl_old_shortcut appearing in Fl_Button.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6367 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-03 11:20:50 +00:00
Fabien Costantini
b763b271a7 Doxygen documentation : removed useless FLTK prefix to Modules list as it doesn't change their order in the Modules page.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6366 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-03 08:05:48 +00:00
Fabien Costantini
bd882119e7 Doxygen documentation : minor comment fixes.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6365 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-03 07:48:38 +00:00
engelsman
a95a1f01a9 added doxygen comments for undocumented features of Fl_Free
- converted some HTML tags tags to doxygen \commands



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6364 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01 22:51:30 +00:00
engelsman
2b7fa0f60e added doxygen comments for undocumented features of Fl_FormsPixmap
Q. Is there a potential memory leak if Pixmap(B) called after set(b) ?



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6363 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01 22:02:55 +00:00
engelsman
4db42c2996 doxygen comments for undocumented features of Fl_File_Init
- is Fl_File_Input::errorcolor() ever used?



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6362 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-01 18:43:10 +00:00
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