diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile | 2 | ||||
| -rw-r--r-- | doc/commands.doc | 4 | ||||
| -rw-r--r-- | doc/docblocks.doc | 2 | ||||
| -rw-r--r-- | doc/doxygen_manual.tex | 2 | ||||
| -rw-r--r-- | doc/index.doc | 1 | ||||
| -rw-r--r-- | doc/lists.doc | 89 | ||||
| -rw-r--r-- | doc/starting.doc | 38 |
7 files changed, 96 insertions, 42 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile index 9c299b1..f992010 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -30,7 +30,7 @@ ENABLED_SECTIONS = logo_on ENABLE_PREPROCESSING = NO CASE_SENSE_NAMES = NO IMAGE_PATH = . -INPUT = index.doc install.doc starting.doc docblocks.doc \ +INPUT = index.doc install.doc starting.doc docblocks.doc lists.doc \ grouping.doc formulas.doc diagrams.doc preprocessing.doc \ external.doc faq.doc trouble.doc history.doc features.doc \ doxygen_usage.doc doxytag_usage.doc doxysearch_usage.doc \ diff --git a/doc/commands.doc b/doc/commands.doc index dd0c378..80b032b 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -179,7 +179,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude define.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define.h.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define_h.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly @@ -270,7 +270,7 @@ Doxygen. Unrecognized commands are treated as normal text. \par Example: \verbinclude file.h \htmlonly - Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file.h.html">here</a> + Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file_h.html">here</a> for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly diff --git a/doc/docblocks.doc b/doc/docblocks.doc index f02d11f..3ac2789 100644 --- a/doc/docblocks.doc +++ b/doc/docblocks.doc @@ -204,7 +204,7 @@ Here is an example of a the use of these comment blocks: inside these comment blocks. \htmlonly -Go to the <a href="grouping.html">next</a> section or return to the +Go to the <a href="lists.html">next</a> section or return to the <a href="index.html">index</a>. \endhtmlonly diff --git a/doc/doxygen_manual.tex b/doc/doxygen_manual.tex index 6bab05e..a9448be 100644 --- a/doc/doxygen_manual.tex +++ b/doc/doxygen_manual.tex @@ -20,6 +20,7 @@ \usepackage{doxygen} \usepackage{multicol} \usepackage{times} +\usepackage{alltt} \usepackage[pagebackref=true, colorlinks=true, linkcolor=blue @@ -46,6 +47,7 @@ Written by Dimitri van Heesch\\[2ex] \input{install} \input{starting} \input{docblocks} +\input{lists} \input{grouping} \input{formulas} \input{diagrams} diff --git a/doc/index.doc b/doc/index.doc index 198bf46..9c7619f 100644 --- a/doc/index.doc +++ b/doc/index.doc @@ -89,6 +89,7 @@ The first part forms a user manual: documentation quickly. <li>Section \ref docblocks demonstrates the various ways that code can be documented. +<li>Section \ref lists show various ways to create lists. <li>Section \ref grouping shows how to group things together. <li>Section \ref formulas shows how to insert formulas in the documentation. <li>Section \ref diagrams describes the diagrams and graphs that doxygen can generate. diff --git a/doc/lists.doc b/doc/lists.doc new file mode 100644 index 0000000..eaf8616 --- /dev/null +++ b/doc/lists.doc @@ -0,0 +1,89 @@ +/*! \page lists Lists + +Doxygen has a number of ways to create lists of items. + +<b>Using dashes</b> + + By putting a number of column-aligned minus signs at the start of a + line, a bullet list will automatically be generated. + Numbered lists can also be generated by using a minus followed by a hash. + Nesting of lists is allowed.<p> + Here is an example: +\verbatim + /*! + * A list of events: + * - mouse events + * -# mouse move event + * -# mouse click event\n + * More info about the click event. + * -# mouse double click event + * - keyboard events + * -# key down event + * -# key up event + * + * More text here. + */ +\endverbatim + The result will be: + + A list of events: + - mouse events + -# mouse move event + -# mouse click event\n + More info about the click event. + -# mouse double click event + - keyboard events + -# key down event + -# key up event + + More text here. + +If you use tabs within lists, please make sure that \ref cfg_tab_size "TAB_SIZE" in the +configuration file is set to the correct tab size. + +<b>Using HTML commands</b> + +If you like you can also use HTML commands inside the documentation +blocks. Using these commands has the advantage that it is more natural +for list items that consists of multiple paragraphs. + +Here is the above example with HTML commands: +\verbatim + /*! + * A list of events: + * <ul> + * <li> mouse events + * <ol> + * <li>mouse move event + * <li>mouse click event\n + * More info about the click event. + * <li>mouse double click event + * </ol> + * <li> keyboard events + * <ol> + * <li>key down event + * <li>key up event + * </ol> + * </ul> + * More text here. + */ +\endverbatim + +\note The the indent here is not important. + +<b>Using \\arg or \@li</b> + +For compatibility with the Troll Tech's internal documentation tool and +with KDoc, doxygen has two commands that can be used to create simple +not nested lists. + +See \ref cmdarg "\arg" and \ref cmdli "\li" for more info. + +\htmlonly +Go to the <a href="grouping.html">next</a> section or return to the + <a href="index.html">index</a>. +\endhtmlonly + +*/ + + diff --git a/doc/starting.doc b/doc/starting.doc index cd48df3..b518838 100644 --- a/doc/starting.doc +++ b/doc/starting.doc @@ -197,43 +197,6 @@ During parsing the following steps take place: See section \ref htmlcmds for an overview of all supported HTML tags. </ul> - By putting a number of column-aligned minus signs at the start of a - line, a bullet list will automatically be generated. - Numbered lists can also be generated by using a minus followed by a hash. - Nesting of lists is allowed.<p> - Here is an example: -\verbatim - /*! - * A list of events: - * - mouse events - * -# mouse move event - * -# mouse click event\n - * More info about the click event. - * -# mouse double click event - * - keyboard events - * -# key down event - * -# key up event - * - * More text here. - */ -\endverbatim - The result will be: - - A list of events: - - mouse events - -# mouse move event - -# mouse click event\n - More info about the click event. - -# mouse double click event - - keyboard events - -# key down event - -# key up event - - More text here. - -If you use tabs within lists, please make sure that \ref cfg_tab_size "TAB_SIZE" in the -configuration file is set to the correct tab size. - \htmlonly Go to the <a href="docblocks.html">next</a> section or return to the <a href="index.html">index</a>. @@ -241,4 +204,3 @@ Go to the <a href="docblocks.html">next</a> section or return to the */ - |