Commit Graph

28 Commits

Author SHA1 Message Date
Albrecht Schlosser
aa4342fe1a Next try to improve documentation title and version numbers.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8254 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-11 10:49:50 +00:00
Albrecht Schlosser
1cccb74748 Fixed Doxygen version numbers (and better HTML title with version number).
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8253 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-11 10:37:47 +00:00
Manolo Gouy
bc509d32eb Fix STR #2504 (first part). Replaced HAVE _CAIRO by FLTK_HAVE_CAIRO and USE_CAIRO
by FLTK_USE_CAIRO everywhere.

git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@8198 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2011-01-06 10:24:58 +00:00
engelsman
61261c2917 added html_stylesheet.css for control over doxygen generated html
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6810 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-06-30 18:51:09 +00:00
engelsman
c95505b462 removed numbering from doxygen chapters and navigation bars,
moved class/function reference pages to end of index table,
swapped editor/drawing chapters in Doxybook for PDF version



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-25 23:12:48 +00:00
Albrecht Schlosser
6b410fd4c5 changed brief docs sort order, as discussed in fltk.general
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6701 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-03-20 16:11:34 +00:00
Fabien Costantini
b00d2bfa42 Doxygen documentation
+ Added a new Module section named : File names and URI utility funtions
+ updated the pdf file adequately



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6641 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2009-01-20 11:10:29 +00:00
Fabien Costantini
73a2fa5b99 Doxygen documentation:
- Fixed recent documentation update problems in fl_draw.cxx : \ and @ char must be doubled otherwise interpreted as doxygen keywords
- Fixed some doxygenized parameters problems in Fl_Preferences.cxx
- Added the treeview mode, now featuring a vertical left tree browser in html doc
- Splitted html configuration file from pdf configuration file, now a new Doxybook config file permits to customize independtly both html and pdf modes without risking side effects and also without assuming an fltk user will have the Tex tools installed to generate the html doc. Now only pdf generation will need LaTex tools.
- Updated the doxygen based documentation to revison 9 and added new significant contributors to index.dox in alphabetical order.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6539 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-12-03 01:02:10 +00:00
Fabien Costantini
fd13aabd19 Enabled Xcode docset makefile generation as it is transparent for non xcode users.
More precisely this option only adds a new hmtl/Makefile target and will permit 
to make and install fltk doc to be incorporated to XCode 3, 
but it is not automatically generated, even on the mac platform; 
as you still have to run manually make install from the html directory to activate that one. 
Works Great, FLTK documentation side by side with Apple Documentation in your XCode environment !!!



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6457 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-18 16:23:26 +00:00
Fabien Costantini
6ff84799a3 Moved latex related files to src, man files to src, updated Makefile and Doxyfile accordingly.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6453 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-17 12:42:28 +00:00
Fabien Costantini
14ca02ffff Doxygen documentation: commented out the 1.5.7 specific doc options, updated README for pdf and html use. Now minimum version required is 1.5.5
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6440 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-15 15:58:04 +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
497afccb07 Doxygen pdf man: First version added in documentation/fltk.pdf, old doc removed, images, dox files moved to a new src directory.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6431 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 22:12:25 +00:00
Fabien Costantini
7a90386c6d Doxygen pdf documentation: OUTPUT_DIRECTORY is now . Changed the ABSOLUTE_PATH_NAMES as suggested but it seems that there is a bug in doxygen as the pdf TOC still shows the path but not the content pages.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6429 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-14 20:54:00 +00:00
Fabien Costantini
86fee3f0d1 Set CASE SENSE NAME option to YES as discussed.
git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6424 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-13 23:12:51 +00:00
engelsman
4fb871e245 first steps towards doxygen to LaTeX to PDF generation
- Doxyfile: enable LATEX generation
- index.dox: table simplified, and alternative \image latex added
- FL200.eps: new eps version of FL200.gif
- fltk-book.tex: LaTeX template file, with title page

Note: there are still too many errors in the generated LaTeX because
the html in the *.dox files is too complex for doxygen's understanding,
so we still can't generate the full LaTeX and hence PDF versions.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6402 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-09 20:29:36 +00:00
engelsman
8d5f884b4a added explicit *.dox entries to Doxyfile INPUT variable.
This is needed so that the LaTeX option processes files in the
desired order rather than alphabetical. Not sure whether the
../FL and ../src entries should be mid-list or at the end.



git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6377 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
2008-10-05 16:25:26 +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
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
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
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
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
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
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
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
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