Author: engelsman
Date: 2009-03-25 16:12:48 -0700 (Wed, 25 Mar 2009)
New Revision: 6721
Log:
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
Modified:
branches/branch-1.3/documentation/Doxybook
branches/branch-1.3/documentation/Doxyfile
branches/branch-1.3/documentation/Makefile
branches/branch-1.3/documentation/src/advanced.dox
branches/branch-1.3/documentation/src/basics.dox
branches/branch-1.3/documentation/src/common.dox
branches/branch-1.3/documentation/src/development.dox
branches/branch-1.3/documentation/src/drawing.dox
branches/branch-1.3/documentation/src/editor.dox
branches/branch-1.3/documentation/src/enumerations.dox
branches/branch-1.3/documentation/src/events.dox
branches/branch-1.3/documentation/src/examples.dox
branches/branch-1.3/documentation/src/fluid.dox
branches/branch-1.3/documentation/src/forms.dox
branches/branch-1.3/documentation/src/glut.dox
branches/branch-1.3/documentation/src/index.dox
branches/branch-1.3/documentation/src/intro.dox
branches/branch-1.3/documentation/src/license.dox
branches/branch-1.3/documentation/src/migration_1_1.dox
branches/branch-1.3/documentation/src/migration_1_3.dox
branches/branch-1.3/documentation/src/opengl.dox
branches/branch-1.3/documentation/src/osissues.dox
branches/branch-1.3/documentation/src/preface.dox
branches/branch-1.3/documentation/src/subclassing.dox
branches/branch-1.3/documentation/src/unicode.dox
Modified: branches/branch-1.3/documentation/Doxybook
===================================================================
--- branches/branch-1.3/documentation/Doxybook 2009-03-25 23:09:04 UTC (rev
6720)
+++ branches/branch-1.3/documentation/Doxybook 2009-03-25 23:12:48 UTC (rev
6721)
@@ -557,16 +557,14 @@
src/intro.dox \
src/basics.dox \
src/common.dox \
+ src/editor.dox \
src/drawing.dox \
- src/editor.dox \
src/events.dox \
src/subclassing.dox \
src/opengl.dox \
src/fluid.dox \
src/advanced.dox \
src/unicode.dox \
- ../FL \
- ../src \
src/enumerations.dox \
src/glut.dox \
src/forms.dox \
@@ -575,7 +573,9 @@
src/migration_1_3.dox \
src/development.dox \
src/license.dox \
- src/examples.dox
+ src/examples.dox \
+ ../FL \
+ ../src
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
Modified: branches/branch-1.3/documentation/Doxyfile
===================================================================
--- branches/branch-1.3/documentation/Doxyfile 2009-03-25 23:09:04 UTC (rev
6720)
+++ branches/branch-1.3/documentation/Doxyfile 2009-03-25 23:12:48 UTC (rev
6721)
@@ -557,8 +557,8 @@
src/intro.dox \
src/basics.dox \
src/common.dox \
+ src/editor.dox \
src/drawing.dox \
- src/editor.dox \
src/events.dox \
src/subclassing.dox \
src/opengl.dox \
Modified: branches/branch-1.3/documentation/Makefile
===================================================================
--- branches/branch-1.3/documentation/Makefile 2009-03-25 23:09:04 UTC (rev
6720)
+++ branches/branch-1.3/documentation/Makefile 2009-03-25 23:12:48 UTC (rev
6721)
@@ -49,8 +49,8 @@
$(SRC_DOCDIR)/intro.dox \
$(SRC_DOCDIR)/basics.dox \
$(SRC_DOCDIR)/common.dox \
+ $(SRC_DOCDIR)/editor.dox \
$(SRC_DOCDIR)/drawing.dox \
- $(SRC_DOCDIR)/editor.dox \
$(SRC_DOCDIR)/events.dox \
$(SRC_DOCDIR)/subclassing.dox \
$(SRC_DOCDIR)/opengl.dox \
Modified: branches/branch-1.3/documentation/src/advanced.dox
===================================================================
--- branches/branch-1.3/documentation/src/advanced.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/advanced.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page advanced 10 - Advanced FLTK
+ \page advanced Advanced FLTK
This chapter explains advanced programming and design topics
that will help you to get the most out of FLTK.
@@ -103,7 +103,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="fluid.html">[Previous] 9 - Programming with
FLUID</a>
-<a class="el" href="unicode.html">[Next] 11 - Unicode and utf-8
Support</a>
+<a class="el" href="fluid.html">[Previous] Programming with
FLUID</a>
+<a class="el" href="unicode.html">[Next] Unicode and utf-8
Support</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/basics.dox
===================================================================
--- branches/branch-1.3/documentation/src/basics.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/basics.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page basics 2 - FLTK Basics
+ \page basics FLTK Basics
This chapter teaches you the basics of compiling programs
that use FLTK.
@@ -376,7 +376,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="intro.html">[Previous] 1 - Introduction to
FLTK</a>
-<a class="el" href="common.html">[Next] 3 - Common Widgets and
Attributes</a>
+<a class="el" href="intro.html">[Previous] Introduction to FLTK</a>
+<a class="el" href="common.html">[Next] Common Widgets and
Attributes</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/common.dox
===================================================================
--- branches/branch-1.3/documentation/src/common.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/common.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page common 3 - Common Widgets and Attributes
+ \page common Common Widgets and Attributes
This chapter describes many of the widgets that are provided
with FLTK and covers how to query and set the standard
@@ -589,8 +589,8 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="basics.html">[Previous] 2 - FLTK Basics</a>
-<a class="el" href="editor.html">[Next] 4 - Designing a Simple Text
Editor</a>
+<a class="el" href="basics.html">[Previous] FLTK Basics</a>
+<a class="el" href="editor.html">[Next] Designing a Simple Text
Editor</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/development.dox
===================================================================
--- branches/branch-1.3/documentation/src/development.dox 2009-03-25
23:09:04 UTC (rev 6720)
+++ branches/branch-1.3/documentation/src/development.dox 2009-03-25
23:12:48 UTC (rev 6721)
@@ -1,6 +1,6 @@
/**
- \page development I - Developer Information
+ \page development Developer Information
This chapter describes FLTK development and documentation.
Modified: branches/branch-1.3/documentation/src/drawing.dox
===================================================================
--- branches/branch-1.3/documentation/src/drawing.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/drawing.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page drawing 5 - Drawing Things in FLTK
+ \page drawing Drawing Things in FLTK
This chapter covers the drawing functions that are provided with FLTK.
@@ -1004,7 +1004,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="editor.html">[Previous] 4 - Designing a Simple Text
Editor</a>
-<a class="el" href="events.html">[Next] 6 - Handling Events</a>
+<a class="el" href="editor.html">[Previous] Designing a Simple Text
Editor</a>
+<a class="el" href="events.html">[Next] Handling Events</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/editor.dox
===================================================================
--- branches/branch-1.3/documentation/src/editor.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/editor.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page editor 4 - Designing a Simple Text Editor
+ \page editor Designing a Simple Text Editor
This chapter takes you through the design of a simple
FLTK-based text editor.
@@ -894,7 +894,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="common.html">[Previous] 3 - Common Widgets and
Attributes</a>
-<a class="el" href="drawing.html">[Next] 5 - Drawing Things in
FLTK</a>
+<a class="el" href="common.html">[Previous] Common Widgets and
Attributes</a>
+<a class="el" href="drawing.html">[Next] Drawing Things in FLTK</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/enumerations.dox
===================================================================
--- branches/branch-1.3/documentation/src/enumerations.dox 2009-03-25
23:09:04 UTC (rev 6720)
+++ branches/branch-1.3/documentation/src/enumerations.dox 2009-03-25
23:12:48 UTC (rev 6721)
@@ -1,6 +1,6 @@
/**
- \page enumerations C - FLTK Enumerations
+ \page enumerations FLTK Enumerations
\note This file is not actively maintained any more, but is left
here as a reference, until the doxygen documentation is
@@ -293,7 +293,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="globals_func.html">[Previous] Function Reference</a>
+<a class="el" href="unicode.html">[Previous] Unicode and UTF-8
Support</a>
<a class="el" href="glut.html">[Next] GLUT Compatibility</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/events.dox
===================================================================
--- branches/branch-1.3/documentation/src/events.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/events.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page events 6 - Handling Events
+ \page events Handling Events
This chapter discusses the FLTK event model and how to handle
events in your program or widget.
@@ -398,7 +398,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="drawing.html">[Previous] 5 - Drawing Things in
FLTK</a>  :
-<a class="el" href="subclassing.html">[Next] 7 - Adding and Extending
Widgets</a>
+<a class="el" href="drawing.html">[Previous] Drawing Things in
FLTK</a>  :
+<a class="el" href="subclassing.html">[Next] Adding and Extending
Widgets</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/examples.dox
===================================================================
--- branches/branch-1.3/documentation/src/examples.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/examples.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page examples K - Example Source Code
+ \page examples Example Source Code
\par March 19, 2005
Modified: branches/branch-1.3/documentation/src/fluid.dox
===================================================================
--- branches/branch-1.3/documentation/src/fluid.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/fluid.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -3,7 +3,7 @@
<!-- Warning: \p .h does not work but <tt>.h</tt> does -->
<!-- Warning: \p .cxx does not work but <tt>.cxx</tt> does -->
- \page fluid 9 - Programming with FLUID
+ \page fluid Programming with FLUID
This chapter shows how to use the Fast Light User-Interface Designer
("FLUID") to create your GUIs.
@@ -1389,7 +1389,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="opengl.html">[Previous] 8 - Using OpenGL</a>
-<a class="el" href="advanced.html">[Next] 10 - Advanced FLTK</a>
+<a class="el" href="opengl.html">[Previous] Using OpenGL</a>
+<a class="el" href="advanced.html">[Next] Advanced FLTK</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/forms.dox
===================================================================
--- branches/branch-1.3/documentation/src/forms.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/forms.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page forms E - Forms Compatibility
+ \page forms Forms Compatibility
This appendix describes the Forms compatibility included with FLTK.
Modified: branches/branch-1.3/documentation/src/glut.dox
===================================================================
--- branches/branch-1.3/documentation/src/glut.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/glut.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page glut D - GLUT Compatibility
+ \page glut GLUT Compatibility
This appendix describes the GLUT compatibility header file supplied with
FLTK. FLTK's GLUT compatibility is based on the original GLUT 3.7 and
Modified: branches/branch-1.3/documentation/src/index.dox
===================================================================
--- branches/branch-1.3/documentation/src/index.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/index.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -36,27 +36,27 @@
\subpage basics
\subpage common
- \li \ref drawing_colors
- \li \ref common_boxtypes
- \li \ref common_labels
- \li \ref drawing_images
+ - \ref drawing_colors
+ - \ref common_boxtypes
+ - \ref common_labels
+ - \ref drawing_images
\subpage editor
\subpage drawing
\subpage events
- \li \ref events_event_xxx
- \li \ref events_propagation
+ - \ref events_event_xxx
+ - \ref events_propagation
\subpage subclassing
\subpage opengl
\subpage fluid
- \li \ref fluid_widget_attributes
- \li \ref fluid_selecting_moving
- \li \ref fluid_images
+ - \ref fluid_widget_attributes
+ - \ref fluid_selecting_moving
+ - \ref fluid_images
</TD>
<TD ALIGN="LEFT" VALIGN="TOP">
@@ -65,34 +65,42 @@
\subpage unicode
- <b><a class="el" href="annotated.html">A - Class Reference</a></b>
+ <b>Appendices:</b>
+
+ - \subpage enumerations
- <b><a class="el" href="globals_func.html">B - Function Reference</a></b>
+ - \subpage glut
+ - \ref glut_Fl_Glut_Window
+ <!-- - Fl_Glut_Window (not yet commented ?) -->
- \subpage enumerations
+ - \subpage forms
- \subpage glut
- \li \ref glut_Fl_Glut_Window
- <!-- \li Fl_Glut_Window (not yet commented ?) -->
+ - \subpage osissues
- \subpage forms
+ - \subpage migration_1_1
- \subpage osissues
+ - \subpage migration_1_3
- \subpage migration_1_1
+ - \subpage development
- \subpage migration_1_3
+ - \subpage license
- \subpage development
+ - \subpage examples
- \subpage license
+ <b>References:</b>
- \subpage examples
+ - <b><a class="el" href="annotated.html">Class Reference</a></b>
+ - <b><a class="el" href="globals_func.html">Function Reference</a></b>
+
</TD>
</TR>
</TABLE>
+\todo The Index link in the html navigation bar needs to be removed
+ or reconfigured as it creates a nested frame in firefox/linux
+ whereas the MainPage tab at the top of the page works properly.
+
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
Modified: branches/branch-1.3/documentation/src/intro.dox
===================================================================
--- branches/branch-1.3/documentation/src/intro.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/intro.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page intro 1 - Introduction to FLTK
+ \page intro Introduction to FLTK
The Fast Light Tool Kit ("FLTK", pronounced
"fulltick") is a cross-platform C++ GUI toolkit for
@@ -350,6 +350,6 @@
<hr>
<a class="el" href="index.html">[Index]</a>
<a class="el" href="preface.html">[Previous] Preface</a>
-<a class="el" href="basics.html">[Next] 2 - FLTK Basics</a>
+<a class="el" href="basics.html">[Next] FLTK Basics</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/license.dox
===================================================================
--- branches/branch-1.3/documentation/src/license.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/license.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page license J - Software License
+ \page license Software License
\par December 11, 2001
Modified: branches/branch-1.3/documentation/src/migration_1_1.dox
===================================================================
--- branches/branch-1.3/documentation/src/migration_1_1.dox 2009-03-25
23:09:04 UTC (rev 6720)
+++ branches/branch-1.3/documentation/src/migration_1_1.dox 2009-03-25
23:12:48 UTC (rev 6721)
@@ -1,6 +1,6 @@
/**
- \page migration_1_1 G - Migrating Code from FLTK 1.0 to 1.1
+ \page migration_1_1 Migrating Code from FLTK 1.0 to 1.1
This appendix describes the differences between the FLTK
Modified: branches/branch-1.3/documentation/src/migration_1_3.dox
===================================================================
--- branches/branch-1.3/documentation/src/migration_1_3.dox 2009-03-25
23:09:04 UTC (rev 6720)
+++ branches/branch-1.3/documentation/src/migration_1_3.dox 2009-03-25
23:12:48 UTC (rev 6721)
@@ -1,6 +1,6 @@
/**
- \page migration_1_3 H - Migrating Code from FLTK 1.1 to 1.3
+ \page migration_1_3 Migrating Code from FLTK 1.1 to 1.3
This appendix describes the differences between the FLTK
1.1.x and FLTK 1.3.x functions and classes.
Modified: branches/branch-1.3/documentation/src/opengl.dox
===================================================================
--- branches/branch-1.3/documentation/src/opengl.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/opengl.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page opengl 8 - Using OpenGL
+ \page opengl Using OpenGL
This chapter discusses using FLTK for your OpenGL applications.
@@ -460,7 +460,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="subclassing.html">[Previous] 7 - Adding and
Extending Widgets</a>
-<a class="el" href="fluid.html">[Next] 9 - Programming with
FLUID</a>
+<a class="el" href="subclassing.html">[Previous] Adding and Extending
Widgets</a>
+<a class="el" href="fluid.html">[Next] Programming with FLUID</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/osissues.dox
===================================================================
--- branches/branch-1.3/documentation/src/osissues.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/osissues.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page osissues F - Operating System Issues
+ \page osissues Operating System Issues
This appendix describes the operating system specific interfaces in FLTK.
Modified: branches/branch-1.3/documentation/src/preface.dox
===================================================================
--- branches/branch-1.3/documentation/src/preface.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/preface.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -28,8 +28,6 @@
\li \ref fluid
\li \ref advanced
\li \ref unicode
-\li <A class="el" HREF="annotated.html">A - Class Reference</A>
-\li <A class="el" HREF="functions.html#functions">B - Function Reference</A>
\li \ref enumerations
\li \ref glut
\li \ref forms
@@ -39,6 +37,10 @@
\li \ref development
\li \ref license
\li \ref examples
+\li <A class="el" HREF="annotated.html">Class Reference</A>
+\li <A class="el" HREF="functions.html#functions">Function Reference</A>
+\todo Remove or reconfigure old HTML links as these are relative
+ to the source directories and fail in the PDF version!
\section preface_conventions Conventions
@@ -46,6 +48,7 @@
\li Function and constant names are shown in <B><TT>bold courier type</TT></B>
\li Code samples and commands are shown in <TT>regular courier type</TT>
+\todo The old typeface conventions need to be rethought for doxygen.
\section preface_abbreviations Abbreviations
@@ -78,7 +81,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="intro.html">[Next] 1 - Introduction to FLTK</a>
+<a class="el" href="intro.html">[Next] Introduction to FLTK</a>
\endhtmlonly
*/
Modified: branches/branch-1.3/documentation/src/subclassing.dox
===================================================================
--- branches/branch-1.3/documentation/src/subclassing.dox 2009-03-25
23:09:04 UTC (rev 6720)
+++ branches/branch-1.3/documentation/src/subclassing.dox 2009-03-25
23:12:48 UTC (rev 6721)
@@ -1,6 +1,6 @@
/**
- \page subclassing 7 - Adding and Extending Widgets
+ \page subclassing Adding and Extending Widgets
This chapter describes how to add your own widgets or extend existing
Modified: branches/branch-1.3/documentation/src/unicode.dox
===================================================================
--- branches/branch-1.3/documentation/src/unicode.dox 2009-03-25 23:09:04 UTC
(rev 6720)
+++ branches/branch-1.3/documentation/src/unicode.dox 2009-03-25 23:12:48 UTC
(rev 6721)
@@ -1,6 +1,6 @@
/**
- \page unicode 11 - Unicode and utf-8 Support
+ \page unicode Unicode and utf-8 Support
This chapter explains how FLTK handles international
text via Unicode and utf-8.
@@ -77,7 +77,7 @@
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a>
-<a class="el" href="advanced.html">[Previous] 10 - Advanced FLTK
</a>
-<a class="el" href="annotated.html">[Next] A - Class Reference</a>
+<a class="el" href="advanced.html">[Previous] Advanced FLTK </a>
+<a class="el" href="enumerations.html">[Next] FLTK Enumerations</a>
\endhtmlonly
*/
_______________________________________________
fltk-commit mailing list
[email protected]
http://lists.easysw.com/mailman/listinfo/fltk-commit
