summaryrefslogtreecommitdiffstats
path: root/doc/starting.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2000-08-06 15:11:00 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2000-08-06 15:11:00 (GMT)
commitc4ef46195917656ebebed63e3fab5c135d9905a2 (patch)
treeaa501b0916e827fee6032245628509acc64efbba /doc/starting.doc
parent5ad8b41eb93b9ca6a4c2ce90837103f8a4e750d8 (diff)
downloadDoxygen-c4ef46195917656ebebed63e3fab5c135d9905a2.zip
Doxygen-c4ef46195917656ebebed63e3fab5c135d9905a2.tar.gz
Doxygen-c4ef46195917656ebebed63e3fab5c135d9905a2.tar.bz2
Release-1.2.0-20000806
Diffstat (limited to 'doc/starting.doc')
-rw-r--r--doc/starting.doc31
1 files changed, 16 insertions, 15 deletions
diff --git a/doc/starting.doc b/doc/starting.doc
index 23c6268..cd48df3 100644
--- a/doc/starting.doc
+++ b/doc/starting.doc
@@ -197,21 +197,22 @@ During parsing the following steps take place:
See section \ref htmlcmds for an overview of all supported HTML tags.
</ul>
-Using a number of column-aligned minus signs at the start of a
- line in a comment block will generate a bullet list.
- Nested lists are also possible.
+ 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
- * - mouse double click event\n
- * More info about the click event.
+ * -# 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
+ * -# key down event
+ * -# key up event
*
* More text here.
*/
@@ -220,13 +221,13 @@ Using a number of column-aligned minus signs at the start of a
A list of events:
- mouse events
- - mouse move event
- - mouse click event\n
- More info about the click event.
- - mouse double click event
+ -# 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
+ -# key down event
+ -# key up event
More text here.