summaryrefslogtreecommitdiff
path: root/documentation/src
diff options
context:
space:
mode:
authorengelsman <engelsman>2009-03-25 23:12:48 +0000
committerengelsman <engelsman>2009-03-25 23:12:48 +0000
commitc95505b4621f88a364abff8d2807a204896ffcd1 (patch)
treeac030664219895090d1c645a566a12283338bb8e /documentation/src
parentf414a50dd2156541d9b53ada0ad988328b8b6e80 (diff)
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 git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6721 ea41ed52-d2ee-0310-a9c1-e6b18d33e121
Diffstat (limited to 'documentation/src')
-rw-r--r--documentation/src/advanced.dox6
-rw-r--r--documentation/src/basics.dox6
-rw-r--r--documentation/src/common.dox6
-rw-r--r--documentation/src/development.dox2
-rw-r--r--documentation/src/drawing.dox6
-rw-r--r--documentation/src/editor.dox6
-rw-r--r--documentation/src/enumerations.dox4
-rw-r--r--documentation/src/events.dox6
-rw-r--r--documentation/src/examples.dox2
-rw-r--r--documentation/src/fluid.dox6
-rw-r--r--documentation/src/forms.dox2
-rw-r--r--documentation/src/glut.dox2
-rw-r--r--documentation/src/index.dox52
-rw-r--r--documentation/src/intro.dox4
-rw-r--r--documentation/src/license.dox2
-rw-r--r--documentation/src/migration_1_1.dox2
-rw-r--r--documentation/src/migration_1_3.dox2
-rw-r--r--documentation/src/opengl.dox6
-rw-r--r--documentation/src/osissues.dox2
-rw-r--r--documentation/src/preface.dox9
-rw-r--r--documentation/src/subclassing.dox2
-rw-r--r--documentation/src/unicode.dox6
22 files changed, 76 insertions, 65 deletions
diff --git a/documentation/src/advanced.dox b/documentation/src/advanced.dox
index 4afc929b4..5df80bc30 100644
--- a/documentation/src/advanced.dox
+++ b/documentation/src/advanced.dox
@@ -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 @@ Fl::unlock().
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="fluid.html">[Previous]&nbsp; 9 - Programming with FLUID</a>&nbsp;
-<a class="el" href="unicode.html">[Next]&nbsp; 11 - Unicode and utf-8 Support</a>&nbsp;
+<a class="el" href="fluid.html">[Previous]&nbsp; Programming with FLUID</a>&nbsp;
+<a class="el" href="unicode.html">[Next]&nbsp; Unicode and utf-8 Support</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/basics.dox b/documentation/src/basics.dox
index 1af6058fb..5f02ebaf2 100644
--- a/documentation/src/basics.dox
+++ b/documentation/src/basics.dox
@@ -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 @@ include lines:</i>
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="intro.html">[Previous]&nbsp; 1 - Introduction to FLTK</a>&nbsp;
-<a class="el" href="common.html">[Next]&nbsp; 3 - Common Widgets and Attributes</a>&nbsp;
+<a class="el" href="intro.html">[Previous]&nbsp; Introduction to FLTK</a>&nbsp;
+<a class="el" href="common.html">[Next]&nbsp; Common Widgets and Attributes</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/common.dox b/documentation/src/common.dox
index ab0e43c98..dbc0bfa5e 100644
--- a/documentation/src/common.dox
+++ b/documentation/src/common.dox
@@ -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 @@ combined with any modifiers like \c Shift , \c Alt , and \c Control .
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="basics.html">[Previous]&nbsp; 2 - FLTK Basics</a>&nbsp;
-<a class="el" href="editor.html">[Next]&nbsp; 4 - Designing a Simple Text Editor</a>&nbsp;
+<a class="el" href="basics.html">[Previous]&nbsp; FLTK Basics</a>&nbsp;
+<a class="el" href="editor.html">[Next]&nbsp; Designing a Simple Text Editor</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/development.dox b/documentation/src/development.dox
index d4f0efa13..5f2169530 100644
--- a/documentation/src/development.dox
+++ b/documentation/src/development.dox
@@ -1,6 +1,6 @@
/**
- \page development I - Developer Information
+ \page development Developer Information
This chapter describes FLTK development and documentation.
diff --git a/documentation/src/drawing.dox b/documentation/src/drawing.dox
index 5e701f7ba..ec61e05dc 100644
--- a/documentation/src/drawing.dox
+++ b/documentation/src/drawing.dox
@@ -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 @@ in the offscreen buffer into the current buffer at <tt>x, y</tt>.
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="editor.html">[Previous]&nbsp; 4 - Designing a Simple Text Editor</a>&nbsp;
-<a class="el" href="events.html">[Next]&nbsp; 6 - Handling Events</a>&nbsp;
+<a class="el" href="editor.html">[Previous]&nbsp; Designing a Simple Text Editor</a>&nbsp;
+<a class="el" href="events.html">[Next]&nbsp; Handling Events</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/editor.dox b/documentation/src/editor.dox
index 51fd40047..5898b9380 100644
--- a/documentation/src/editor.dox
+++ b/documentation/src/editor.dox
@@ -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 @@ style_parse(const char *text,
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="common.html">[Previous]&nbsp; 3 - Common Widgets and Attributes</a>&nbsp;
-<a class="el" href="drawing.html">[Next]&nbsp; 5 - Drawing Things in FLTK</a>&nbsp;
+<a class="el" href="common.html">[Previous]&nbsp; Common Widgets and Attributes</a>&nbsp;
+<a class="el" href="drawing.html">[Next]&nbsp; Drawing Things in FLTK</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/enumerations.dox b/documentation/src/enumerations.dox
index 5577da6d3..c42d0647c 100644
--- a/documentation/src/enumerations.dox
+++ b/documentation/src/enumerations.dox
@@ -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 @@ The following damage mask bits are used by the standard FLTK widgets:
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="globals_func.html">[Previous] Function Reference</a>&nbsp;
+<a class="el" href="unicode.html">[Previous] Unicode and UTF-8 Support</a>&nbsp;
<a class="el" href="glut.html">[Next] GLUT Compatibility</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/events.dox b/documentation/src/events.dox
index 8728732bb..80c6df7a7 100644
--- a/documentation/src/events.dox
+++ b/documentation/src/events.dox
@@ -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 @@ The following methods are provided for character composition:
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="drawing.html">[Previous]&nbsp; 5 - Drawing Things in FLTK</a>&nbsp;&nbsp:
-<a class="el" href="subclassing.html">[Next]&nbsp; 7 - Adding and Extending Widgets</a>
+<a class="el" href="drawing.html">[Previous]&nbsp; Drawing Things in FLTK</a>&nbsp;&nbsp:
+<a class="el" href="subclassing.html">[Next]&nbsp; Adding and Extending Widgets</a>
\endhtmlonly
*/
diff --git a/documentation/src/examples.dox b/documentation/src/examples.dox
index 0141acacc..ad3e6de84 100644
--- a/documentation/src/examples.dox
+++ b/documentation/src/examples.dox
@@ -1,6 +1,6 @@
/**
- \page examples K - Example Source Code
+ \page examples Example Source Code
\par March 19, 2005
diff --git a/documentation/src/fluid.dox b/documentation/src/fluid.dox
index 1ed3a1eb6..a83bfc1dd 100644
--- a/documentation/src/fluid.dox
+++ b/documentation/src/fluid.dox
@@ -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 @@ be generated and likely cause compile-time warnings.
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="opengl.html">[Previous]&nbsp; 8 - Using OpenGL</a> &nbsp;&nbsp;
-<a class="el" href="advanced.html">[Next]&nbsp; 10 - Advanced FLTK</a>
+<a class="el" href="opengl.html">[Previous]&nbsp; Using OpenGL</a> &nbsp;&nbsp;
+<a class="el" href="advanced.html">[Next]&nbsp; Advanced FLTK</a>
\endhtmlonly
*/
diff --git a/documentation/src/forms.dox b/documentation/src/forms.dox
index bd7796726..45dbfc32a 100644
--- a/documentation/src/forms.dox
+++ b/documentation/src/forms.dox
@@ -1,6 +1,6 @@
/**
- \page forms E - Forms Compatibility
+ \page forms Forms Compatibility
This appendix describes the Forms compatibility included with FLTK.
diff --git a/documentation/src/glut.dox b/documentation/src/glut.dox
index 0298a329e..09958f767 100644
--- a/documentation/src/glut.dox
+++ b/documentation/src/glut.dox
@@ -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
diff --git a/documentation/src/index.dox b/documentation/src/index.dox
index 83a11aab0..699bf3d61 100644
--- a/documentation/src/index.dox
+++ b/documentation/src/index.dox
@@ -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> &nbsp;&nbsp;
diff --git a/documentation/src/intro.dox b/documentation/src/intro.dox
index 4fdc52860..0af053fe5 100644
--- a/documentation/src/intro.dox
+++ b/documentation/src/intro.dox
@@ -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 @@ at "fltk@fltk.org" or one of the newsgroups.
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
<a class="el" href="preface.html">[Previous] Preface</a> &nbsp;&nbsp;
-<a class="el" href="basics.html">[Next]&nbsp; 2 - FLTK Basics</a>
+<a class="el" href="basics.html">[Next]&nbsp; FLTK Basics</a>
\endhtmlonly
*/
diff --git a/documentation/src/license.dox b/documentation/src/license.dox
index f1ae144c7..68b690320 100644
--- a/documentation/src/license.dox
+++ b/documentation/src/license.dox
@@ -1,6 +1,6 @@
/**
- \page license J - Software License
+ \page license Software License
\par December 11, 2001
diff --git a/documentation/src/migration_1_1.dox b/documentation/src/migration_1_1.dox
index 5abd94d9a..67615c889 100644
--- a/documentation/src/migration_1_1.dox
+++ b/documentation/src/migration_1_1.dox
@@ -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
diff --git a/documentation/src/migration_1_3.dox b/documentation/src/migration_1_3.dox
index b812d2125..cf5bfdb45 100644
--- a/documentation/src/migration_1_3.dox
+++ b/documentation/src/migration_1_3.dox
@@ -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.
diff --git a/documentation/src/opengl.dox b/documentation/src/opengl.dox
index cc88f089f..e1eaa4969 100644
--- a/documentation/src/opengl.dox
+++ b/documentation/src/opengl.dox
@@ -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 @@ after this call.
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="subclassing.html">[Previous]&nbsp; 7 - Adding and Extending Widgets</a>&nbsp;
-<a class="el" href="fluid.html">[Next]&nbsp; 9 - Programming with FLUID</a>&nbsp;
+<a class="el" href="subclassing.html">[Previous]&nbsp; Adding and Extending Widgets</a>&nbsp;
+<a class="el" href="fluid.html">[Next]&nbsp; Programming with FLUID</a>&nbsp;
\endhtmlonly
*/
diff --git a/documentation/src/osissues.dox b/documentation/src/osissues.dox
index 628d41013..5029a55f9 100644
--- a/documentation/src/osissues.dox
+++ b/documentation/src/osissues.dox
@@ -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.
diff --git a/documentation/src/preface.dox b/documentation/src/preface.dox
index bc3c8e5cf..321a61aba 100644
--- a/documentation/src/preface.dox
+++ b/documentation/src/preface.dox
@@ -28,8 +28,6 @@ This manual is organized into the following chapters and appendices:
\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 @@ This manual is organized into the following chapters and appendices:
\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 @@ The following typeface conventions are used in this manual:
\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 @@ registered trademarks of Apple Computer, Inc.
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="intro.html">[Next] 1 - Introduction to FLTK</a>
+<a class="el" href="intro.html">[Next] Introduction to FLTK</a>
\endhtmlonly
*/
diff --git a/documentation/src/subclassing.dox b/documentation/src/subclassing.dox
index 684833d6f..f25881311 100644
--- a/documentation/src/subclassing.dox
+++ b/documentation/src/subclassing.dox
@@ -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
diff --git a/documentation/src/unicode.dox b/documentation/src/unicode.dox
index f352be652..559bfe5a9 100644
--- a/documentation/src/unicode.dox
+++ b/documentation/src/unicode.dox
@@ -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 @@ system, FLTK will convert string as needed.
\htmlonly
<hr>
<a class="el" href="index.html">[Index]</a> &nbsp;&nbsp;
-<a class="el" href="advanced.html">[Previous]&nbsp; 10 - Advanced FLTK </a>&nbsp;
-<a class="el" href="annotated.html">[Next]&nbsp; A - Class Reference</a>
+<a class="el" href="advanced.html">[Previous]&nbsp; Advanced FLTK </a>&nbsp;
+<a class="el" href="enumerations.html">[Next]&nbsp; FLTK Enumerations</a>
\endhtmlonly
*/