diff options
| author | Albrecht Schlosser <albrechts.fltk@online.de> | 2008-09-21 14:06:57 +0000 |
|---|---|---|
| committer | Albrecht Schlosser <albrechts.fltk@online.de> | 2008-09-21 14:06:57 +0000 |
| commit | 9ce5dd8c736f6fb9fe130256279f4541740c6817 (patch) | |
| tree | d7e3132f31fb07ad1f78a59c36185ff708e37d8a /documentation/development.dox | |
| parent | 31ad4d23cf12d6dccd6175f4bac4dd3732c0c971 (diff) | |
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
Diffstat (limited to 'documentation/development.dox')
| -rw-r--r-- | documentation/development.dox | 77 |
1 files changed, 71 insertions, 6 deletions
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 "<H1>", \b "<H2>", and \b "<H3>", respectively. +a size like \b "<H1>", \b "<H2>", and \b "<H3>", and \b "<H4>", respectively. By <b>FLTK documentation convention</b>, a file like this one with a doxygen documentation chapter has the name <b>"<chapter>.dox".</b> @@ -219,16 +223,14 @@ The \b \\page statement at the top of the page is <b>"\page <chapter> This is the title"</b>. Sections within a documentation page must be called \b "<chapter>_<section>", where \b "<chapter>" is the name part of the file, and \b "<section>" 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 +<H2><A name="event_xxx">Fl::event_*() methods</A></H2> + +becomes: + +<A NAME="event_xxx"></A> <!-- For old HTML links only ! --> +\section events_event_xxx Fl::event_*() methods +\endcode + +The additional HTML "<A NAME=...>" statement is temporary needed, until +all links (references) are modified, then: + +\code +<H2><A name="event_xxx">Fl::event_*() methods</A></H2> + +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 + + <B> + <UL> + <LI><A HREF="events.html#event_xxx">Fl::event_*() methods</A></LI> + <LI><A HREF="events.html#propagation">Event Propagation</A></LI> + </UL> + </B> + +becomes: + + \subpage events + + <b> + \li \ref events_event_xxx + \li \ref events_propagation + </b> + +\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 <hr> |
