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

documentation/Doxyfile

@@ -945,7 +945,7 @@ ENUM_VALUES_PER_LINE   = 4
 # releases of Doxygen, the values YES and NO are equivalent to FRAME and NONE
 # respectively.
 
-GENERATE_TREEVIEW      = NO
+GENERATE_TREEVIEW      = YES
 
 # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be 
 # used to set the initial width (in pixels) of the frame in which the tree 
@@ -968,7 +968,7 @@ TREEVIEW_WIDTH         = 250
 # If the GENERATE_LATEX tag is set to YES (the default) Doxygen will 
 # generate Latex output.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. 
 # If a relative path is entered the value of OUTPUT_DIRECTORY will be 

documentation/Makefile

@@ -284,6 +284,7 @@ pdf: 	latex/refman.pdf
 
 latex/refman.pdf: latex/refman.tex Doxyfile $(EPSFILES)
 	echo "Generating PDF documentation..."
+	$(DOXYDOC) Doxybook ;\
 	(cd latex ;\
 	pdflatex --interaction=nonstopmode refman.tex ;\
 	makeindex refman.idx ;\

documentation/src/index.dox

@@ -9,8 +9,8 @@
   </CENTER></TD>
 	<TD><CENTER>
 	<B>FLTK 1.3.0 Programming Manual</B>
-	<P>Revision 8 by Michael Sweet, Craig P. Earls,<br>
-	   Matthias Melcher, and Bill Spitzak<br>
+	<P>Revision 9 by F. Costantini, D. Gibson, M. Melcher,<br>
+	   A. Schlosser, B. Spitzak and M. Sweet.<br>
 	   Copyright 1998-2008 by Bill Spitzak and others.</P>
 	</CENTER></TD>
 </TR>

src/Fl_Preferences.cxx

@@ -561,8 +561,8 @@ static void *decodeHex( const char *src, int &size )
  (non-zero) or the default was used (0). 
  'maxSize' is the maximum length of text that will be read. 
  
- \param[in] entry name of entry
- \param[out] value returned from preferences or default value if none was set
+ \param[in] key name of entry
+ \param[out] data value returned from preferences or default value if none was set
  \param[in] defaultValue default value to be used if no preference was set
  \param[in] defaultSize size of default value array
  \param[in] maxSize maximum length of value
@@ -628,7 +628,7 @@ char Fl_Preferences::get( const char *key, void *&data, const void *defaultValue
  
  \param[in] key name of entry
  \param[in] data set this entry to \a value
- \param[in] size of data array
+ \param[in] dsize size of data array
  \return 0 if setting the value failed
  */
 char Fl_Preferences::set( const char *key, const void *data, int dsize )

src/fl_draw.cxx

@@ -102,7 +102,7 @@ static bool handle_utf8_seq(const char * &s,char * &d) {
 }
 
 /**
- Copy \a from  to \a buf, replacing unprintable characters with ^X and \nnn
+ Copy \a from  to \a buf, replacing unprintable characters with ^X and \\nnn
  Stop at a newline or if MAXBUF characters written to buffer.
  Also word-wrap if width exceeds maxw.
  Returns a pointer to the start of the next line of caharcters.
@@ -358,7 +358,7 @@ void fl_draw(
   is non-zero it will wrap to that width.
   \param[in] str nul-terminated string
   \param[out] w,h width and height of string in current font
-  \param[in] draw_symbols non-zero to enable @symbol handling [default=1]
+  \param[in] draw_symbols non-zero to enable @@symbol handling [default=1]
 */
 void fl_measure(const char* str, int& w, int& h, int draw_symbols) {
   if (!str || !*str) {w = 0; h = 0; return;}