fltk/documentation at 501690edce2cecc356334fc42e7f429907cdfa1e - fltk

History

Fabien Costantini 501690edce Last test does keep history, lets add all related files and patch them afterwards... git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6447 ea41ed52-d2ee-0310-a9c1-e6b18d33e121		2008-10-17 11:08:15 +00:00
..
src	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.	2008-10-15 13:46:06 +00:00
src_doc	Last test does keep history, lets add all related files and patch them afterwards...	2008-10-17 11:08:15 +00:00
blocks.man	Do some rearranging of image and desktop support files.	2006-08-25 06:58:33 +00:00
checkers.man	More packaging fun.	2006-01-15 18:36:16 +00:00
Doxyfile	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	2008-10-15 15:58:04 +00:00
fltk-book.tex	first steps towards doxygen to LaTeX to PDF generation	2008-10-09 20:29:36 +00:00
fltk-config.man	STR 1897: fixed man pages for unicode translation	2008-03-16 12:12:55 +00:00
fltk.book	Add handler for thread messages (STR #1536 )	2007-02-08 23:04:20 +00:00
fltk.man	STR 1897: fixed man pages for unicode translation	2008-03-16 12:12:55 +00:00
fluid.man	STR 1897: fixed man pages for unicode translation	2008-03-16 12:12:55 +00:00
html_footer	Updated lots of links in text documentation.	2008-09-21 14:06:57 +00:00
Makefile	Doxygen documentation: Fixes obsolete install data when using make install. Now fltk.pdf and all potential html files are installed in the fltk docdir.	2008-10-16 11:41:58 +00:00
README	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	2008-10-15 15:58:04 +00:00
sudoku.man	More packaging fun.	2006-01-15 18:36:16 +00:00
todo_filelist_doc.txt	Updated the todo list with new devl notes and todo for the pdf doc & makefile	2008-10-14 23:10:57 +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.

*CHECK this and modify: (we currently use doxygen for doc generation) :

You can generate your own (printable) copy of the manual by typing
"make" in this directory.  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).