fltk/documentation
2009-03-24 01:40:44 +00:00
..
src Major documentation update including: now html doc API is sorted, navigation problems/side effects fixed, html tags replaced by proper doxygen commands, parameters command switched from a to p. Includes a pdf update. 2009-03-24 01:40:44 +00:00
Doxybook changed brief docs sort order, as discussed in fltk.general 2009-03-20 16:11:34 +00:00
Doxyfile changed brief docs sort order, as discussed in fltk.general 2009-03-20 16:11:34 +00:00
Makefile Moved the stripping of date comments (strip_tags) to its own target 2009-03-21 10:29:42 +00:00
README Doxygen documentation:updated README 2008-10-18 07:52:26 +00:00
strip_tags Moved the stripping of date comments (strip_tags) to its own target 2009-03-21 10:29:42 +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
------

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).