fltk/documentation at 0906d230edec0cc74681cb8a49f3ff1e5451f601 - fltk

History

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

src

Doxygen documentation:

2008-12-03 01:02:10 +00:00

Doxybook

Doxygen documentation:

2008-12-03 01:02:10 +00:00

Doxyfile

Doxygen documentation:

2008-12-03 01:02:10 +00:00

Makefile

Doxygen documentation:

2008-12-03 01:02:10 +00:00

README

Doxygen documentation:updated README

2008-10-18 07:52:26 +00:00

TODO.doc

Changed the former todo_filelist used for WPs about porting old html to doxygen to a general TODO.doc now.

2008-10-17 12:50:16 +00:00

README

README
------

The documentation in this directory is in PDF format.
To read it, please open the fltk.pdf file in this directory

To generate the doxygen HTML documention,
you should have Doxygen version 1.5.5 min.

To read it, please open the "html/index.html" file. 
A documentation version is also accessable at the FLTK web site, 
along with PostScript(tm) and PDF versions of the manual.

You can generate your own (printable) copy of the manual by typing
"make pdf" in this directory.  

For future book gen alternative (TODO or CHECK):
You will need to have the HTMLDOC software
installed on your system.  HTMLDOC can be downloaded from:
    http://www.easysw.com/htmldoc

The default media size is 8.27x11.0" (210x279mm), which is the lesser
of A4 and US Letter sizes.  You can change this in the makefile by
uncommenting the corresponding media size or defining your own.

If you find any typos, things that are unclear, or would like to
contribute an example, section, or chapter to the FLTK manual, please
contact Michael Sweet (mike@easysw.com).