summaryrefslogtreecommitdiffstats
path: root/doc/lists.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2012-01-10 21:15:46 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2012-01-10 21:15:46 (GMT)
commitfd8b446f8ae60e7d1dc259c6f5fe38c287377d19 (patch)
treeab92980b31825ec310269f7799b1076422132a3e /doc/lists.doc
parent8a65c23b74c33c38b4d1234e76cec74bd08cea69 (diff)
downloadDoxygen-fd8b446f8ae60e7d1dc259c6f5fe38c287377d19.zip
Doxygen-fd8b446f8ae60e7d1dc259c6f5fe38c287377d19.tar.gz
Doxygen-fd8b446f8ae60e7d1dc259c6f5fe38c287377d19.tar.bz2
Release-1.7.6.1-20120110
Diffstat (limited to 'doc/lists.doc')
-rw-r--r--doc/lists.doc27
1 files changed, 16 insertions, 11 deletions
diff --git a/doc/lists.doc b/doc/lists.doc
index f5f9f96..f72957e 100644
--- a/doc/lists.doc
+++ b/doc/lists.doc
@@ -4,9 +4,13 @@ Doxygen provides 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.
+ By putting a number of column-aligned minus (-) signs at the start of a
+ line, a bullet list will automatically be generated. Instead of the minus
+ sign also plus (+) or asterix (\*) can be used.
+
+ Numbered lists can also be generated by using a minus followed by a hash
+ or by using a number followed by a dot.
+
Nesting of lists is allowed and is based on indentation of the items.<p>
Here is an example:
\verbatim
@@ -18,8 +22,8 @@ Doxygen provides a number of ways to create lists of items.
* More info about the click event.
* -# mouse double click event
* - keyboard events
- * -# key down event
- * -# key up event
+ * 1. key down event
+ * 2. key up event
*
* More text here.
*/
@@ -33,8 +37,8 @@ Doxygen provides a number of ways to create lists of items.
More info about the click event.
-# mouse double click event
- keyboard events
- -# key down event
- -# key up event
+ 1. key down event
+ 2. key up event
More text here.
@@ -43,7 +47,7 @@ that \ref cfg_tab_size "TAB_SIZE" in the configuration file is set to
the correct tab size.
You can end a list by starting a new paragraph or
-by putting a dot (.) on an empty line at the same indent level as the
+by putting a dot (.) on an empty line at the same indentation level as the
list you would like to end.
Here is an example that speaks for itself:
@@ -57,9 +61,11 @@ Here is an example that speaks for itself:
* - sub sub item 2
* .
* The dot above ends the sub sub item list.
+ *
* More text for the first sub item
* .
* The dot above ends the first sub item.
+ *
* More text for the first list item
* - sub item 2
* - sub item 3
@@ -74,8 +80,7 @@ Here is an example that speaks for itself:
<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 consist of multiple paragraphs.
+blocks.
Here is the above example with HTML commands:
\verbatim
@@ -85,7 +90,7 @@ Here is the above example with HTML commands:
* <li> mouse events
* <ol>
* <li>mouse move event
- * <li>mouse click event\n
+ * <li>mouse click event<br>
* More info about the click event.
* <li>mouse double click event
* </ol>