From 9ce5dd8c736f6fb9fe130256279f4541740c6817 Mon Sep 17 00:00:00 2001 From: Albrecht Schlosser Date: Sun, 21 Sep 2008 14:06:57 +0000 Subject: Updated lots of links in text documentation. Added missing file "tiny.gif" for html_footer. Updated html_footer (copyright, no date/time, no line break). git-svn-id: file:///fltk/svn/fltk/branches/branch-1.3@6333 ea41ed52-d2ee-0310-a9c1-e6b18d33e121 --- documentation/common.dox | 6 ++-- documentation/development.dox | 77 ++++++++++++++++++++++++++++++++++++++---- documentation/drawing.dox | 8 +++-- documentation/events.dox | 15 ++++---- documentation/fluid.dox | 6 ++-- documentation/glut.dox | 3 +- documentation/html_footer | 6 ++-- documentation/index.dox | 54 ++++++++++++++--------------- documentation/tiny.gif | Bin 0 -> 95 bytes 9 files changed, 122 insertions(+), 53 deletions(-) create mode 100644 documentation/tiny.gif (limited to 'documentation') diff --git a/documentation/common.dox b/documentation/common.dox index fb30b492a..963edbbfd 100644 --- a/documentation/common.dox +++ b/documentation/common.dox @@ -244,7 +244,8 @@ method:

button->labelcolor(FL_WHITE); \endcode -

Box Types

+ +\section common_boxtypes Box Types

The type Fl_Boxtype stored and returned in Fl_Widget::box() is an enumeration defined in Enumerations.H. @@ -342,7 +343,8 @@ value evenly divideable by two. fl_frame(Fl_Boxtype) expects the UP_BOX design at a value divideable by four.

-

Labels and Label Types

+ +\section common_labels Labels and Label Types

The label(), align(), labelfont(), labelsize(), labeltype(), image(), and diff --git a/documentation/development.dox b/documentation/development.dox index c6c5002f4..a8b6a7d58 100644 --- a/documentation/development.dox +++ b/documentation/development.dox @@ -208,10 +208,14 @@ This will appear in the document: \li \b \\page creates a named page \li \b \\section creates a named section within that page - \li \b \\subsection creates a named subsection within that page + \li \b \\subsection creates a named subsection within the current section + \li \b \\subsubsection creates a named subsubsection within the current subsection + +All these statements take a "name" as their first argument, and a title +as their second argument. The title can contain spaces. The page, section, and subsection titles are formatted in blue color and -a size like \b "

", \b "

", and \b "

", respectively. +a size like \b "

", \b "

", and \b "

", and \b "

", respectively. By FLTK documentation convention, a file like this one with a doxygen documentation chapter has the name ".dox". @@ -219,16 +223,14 @@ The \b \\page statement at the top of the page is "\page This is the title". Sections within a documentation page must be called \b "_
", where \b "" is the name part of the file, and \b "
" is a -unique section name within the page that can be referenced in links. +unique section name within the page that can be referenced in links. The +same for subsections and subsubsections. These doxygen page and section commands work only in special documentation chapters, not within normal source or header documentation blocks. However, links \b from normal (e.g. class) documentation \b to documentation sections \b do \b work. -\todo Verify, that links in (from) source documentation to documentation - pages and sections or subsections work. - This page has \code \page development I - Developer Information @@ -287,6 +289,69 @@ appears as: see section \ref development_non-ascii +\section development_old-links Changing Old Links + +Old HTML links and anchors in text documentation pages should be changed +as follows: + +\code +

Fl::event_*() methods

+ +becomes: + + +\section events_event_xxx Fl::event_*() methods +\endcode + +The additional HTML "" statement is temporary needed, until +all links (references) are modified, then: + +\code +

Fl::event_*() methods

+ +becomes: + +\section events_event_xxx Fl::event_*() methods +\endcode + +The "\section" statement can also be a "\subsection" or "\subsubsection" +statement. + +The references (in this example from index.dox) are changes as follows: + +\code + + \subpage events + + + + + +becomes: + + \subpage events + + + \li \ref events_event_xxx + \li \ref events_propagation + + +\endcode + +\section development_html_footer Hack for missing gif file + + \todo + *HACK* : include image file for footer. Doxygen does not include + the file tiny.gif from "html_footer" in its output html dir. + Find out, how this can be done, or avoid using an image in + the HTML footer. + + \image html tiny.gif + + \section navigation_elements Example Navigation Elements
diff --git a/documentation/drawing.dox b/documentation/drawing.dox index 209ebf492..d793f2215 100644 --- a/documentation/drawing.dox +++ b/documentation/drawing.dox @@ -176,7 +176,9 @@ set to zero if the rectangle is completely outside the region. Fl_Region is an operating system specific type. The second form returns the current clipping region. -

Colors

+ + +\section drawing_colors Colors

FLTK manages colors as 32-bit unsigned integers. Values from 0 to 255 represent colors from the FLTK 1.0.x standard colormap @@ -695,7 +697,9 @@ fl_overlay_rect() after FL_DRAG events, and should call fl_overlay_clear() after a FL_RELEASE event.

-

Drawing Images

+ + +\section drawing_images Drawing Images

To draw images, you can either do it directly from data in your memory, or you can create a Fl_Image object. The advantage of diff --git a/documentation/events.dox b/documentation/events.dox index d2610064e..031885ddb 100644 --- a/documentation/events.dox +++ b/documentation/events.dox @@ -15,11 +15,10 @@ window manager.

Events are identified by the integer argument passed to the Fl_Widget::handle() virtual method. Other information about the most recent event is stored in -static locations and acquired by calling the Fl::event_*() methods. This static -information remains valid until the next event is read from the window -system, so it is ok to look at it outside of the handle() -method. +static locations and acquired by calling the \ref events_event_xxx +methods. This static information remains valid until the next event +is read from the window system, so it is ok to look at it outside +of the handle() method.

Mouse Events

@@ -271,7 +270,8 @@ the immediatly following FL_PASTE event. -

Fl::event_*() methods

+ +\section events_event_xxx Fl::event_*() methods

FLTK keeps the information about the most recent event in static storage. This information is good until the next event is @@ -318,7 +318,8 @@ processed. Thus it is valid inside handle() and -

Event Propagation

+ +\section events_propagation Event Propagation

FLTK follows very simple and unchangeable rules for sending events. The major innovation is that widgets can indicate (by diff --git a/documentation/fluid.dox b/documentation/fluid.dox index 17b25297d..5a8323abe 100644 --- a/documentation/fluid.dox +++ b/documentation/fluid.dox @@ -825,7 +825,7 @@ undone, however. \image html fluid_widget_gui.gif "Figure 9-8: The FLUID widget GUI attributes" -

GUI Attributes

+\section fluid_widget_attributes GUI Attributes

Label (text field)

@@ -1100,7 +1100,7 @@ the extra code fields to put these values in.

The No Change button means the callback is done on the matching event even if the data is not changed. -

Selecting and Moving Widgets

+\section fluid_selecting_moving Selecting and Moving Widgets

Double-clicking a window name in the browser will display it, if not displayed yet. From this display you can select widgets, @@ -1155,7 +1155,7 @@ different.

it) is almost identical to the panel for any other Fl_Widget. There are three extra items:

-

Images

+\section fluid_images Image Labels

The contents of the image files in the Image and Inactive text fields are written to the .cxx diff --git a/documentation/glut.dox b/documentation/glut.dox index de3da719c..8ef1a32f5 100644 --- a/documentation/glut.dox +++ b/documentation/glut.dox @@ -77,7 +77,8 @@ glutCreateWindow()! loop calling Fl::wait() to run the program.

-

class Fl_Glut_Window

+ + \section glut_Fl_Glut_Window class Fl_Glut_Window

Class Hierarchy

\code diff --git a/documentation/html_footer b/documentation/html_footer index d273d2ff1..9c15979d7 100644 --- a/documentation/html_footer +++ b/documentation/html_footer @@ -1,9 +1,9 @@
-$datetime. + FLTK -©2008 Bill Spitzak and others. -
Permission is granted to reproduce this manual or any portion for +© 1998-2008 by Bill Spitzak and others.    +Permission is granted to reproduce this manual or any portion for any purpose, provided this copyright and permission notice are preserved.
diff --git a/documentation/index.dox b/documentation/index.dox index 7c42b5bbf..b6b33a4c3 100644 --- a/documentation/index.dox +++ b/documentation/index.dox @@ -28,40 +28,36 @@ \subpage basics \subpage common - - - + + + \li \ref drawing_colors + \li \ref common_boxtypes + \li \ref common_labels + \li \ref drawing_images + \subpage editor \subpage drawing \subpage events - - - + + + \li \ref events_event_xxx + \li \ref events_propagation + \subpage subclassing \subpage opengl \subpage fluid - - - + + + \li \ref fluid_widget_attributes + \li \ref fluid_selecting_moving + \li \ref fluid_images + @@ -71,18 +67,18 @@ \subpage unicode - A - Class Reference + A - Class Reference - B - Function Reference + B - Function Reference \subpage enumerations \subpage glut - - - + + + \li \ref glut_Fl_Glut_Window + + \subpage forms diff --git a/documentation/tiny.gif b/documentation/tiny.gif new file mode 100644 index 000000000..df06e15df Binary files /dev/null and b/documentation/tiny.gif differ -- cgit v1.2.3