summaryrefslogtreecommitdiffstats
path: root/doc/lists.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2005-08-06 11:48:27 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2005-08-06 11:48:27 (GMT)
commitbedb86023002aa3985c914d330f54314d211bdc0 (patch)
tree340cca67808f566b0c458391835834e717e26a61 /doc/lists.doc
parent64c0fdd7432f5d9ddd815fbb459c651f6933a2ea (diff)
downloadDoxygen-bedb86023002aa3985c914d330f54314d211bdc0.zip
Doxygen-bedb86023002aa3985c914d330f54314d211bdc0.tar.gz
Doxygen-bedb86023002aa3985c914d330f54314d211bdc0.tar.bz2
Release-1.4.4-20050806
Diffstat (limited to 'doc/lists.doc')
-rw-r--r--doc/lists.doc11
1 files changed, 6 insertions, 5 deletions
diff --git a/doc/lists.doc b/doc/lists.doc
index 9da03d2..649d83c 100644
--- a/doc/lists.doc
+++ b/doc/lists.doc
@@ -1,13 +1,13 @@
/*! \page lists Lists
-Doxygen has a number of ways to create lists of items.
+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.
- Nesting of lists is allowed.<p>
+ Nesting of lists is allowed and is based on indentation of the items.<p>
Here is an example:
\verbatim
/*!
@@ -38,8 +38,9 @@ Doxygen has a number of ways to create lists of items.
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.
+If you use tabs for indentation within lists, please make sure
+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
@@ -98,7 +99,7 @@ Here is the above example with HTML commands:
*/
\endverbatim
-\note The indentation here is not important.
+\note In this case the indentation is not important.
<b>Using \\arg or \@li</b>