summaryrefslogtreecommitdiffstats
path: root/doc/markdown.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2012-07-12 15:32:41 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2012-07-12 15:32:41 (GMT)
commit52445a98210e9aa50b3fd4bb36995e117539e490 (patch)
tree84ec1ff38937e82a2dfe563fc2d140bc337ffd7f /doc/markdown.doc
parent0ce3aea886f4e95da56d164b3944fd54d3d68f89 (diff)
downloadDoxygen-52445a98210e9aa50b3fd4bb36995e117539e490.zip
Doxygen-52445a98210e9aa50b3fd4bb36995e117539e490.tar.gz
Doxygen-52445a98210e9aa50b3fd4bb36995e117539e490.tar.bz2
Release-1.8.1.2
Diffstat (limited to 'doc/markdown.doc')
-rw-r--r--doc/markdown.doc31
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/markdown.doc b/doc/markdown.doc
index 8bb972e..4df3efc 100644
--- a/doc/markdown.doc
+++ b/doc/markdown.doc
@@ -124,6 +124,8 @@ You can also make a numbered list like so
1. First item.
2. Second item.
+Make sure to also read \ref mddox_lists for doxygen specifics.
+
\subsection md_codeblock Code Blocks
Preformatted verbatim blocks can be created by indenting
@@ -546,6 +548,30 @@ Example:
1. Item1 of list 2
2. Item2 of list 2
+With Markdown the actual numbers you use to mark the list have no
+effect on the HTML output Markdown produces. I.e. it treats the
+following as a list with 3 numbered items:
+
+ 1. Item1
+ 1. Item2
+ 1. Item3
+
+Doxygen however requires that the numbers used as marks are in
+strictly ascending order; an item with a equal or lower number than
+the preceding item, will start a new list. For example:
+
+ 1. Item1 of list 1
+ 3. Item2 of list 1
+ 2. Item1 of list 2
+ 4. Item2 of list 2
+
+will produce:
+
+1. Item1 of list 1
+3. Item2 of list 1
+2. Item1 of list 2
+4. Item2 of list 2
+
Historically doxygen has an additional way to create numbered
lists by using `-#` markers:
@@ -603,4 +629,9 @@ To see the result after Markdown processing you can run doxygen with the
`-d Markdown` option. It will then print each comment block before and
after Markdown processing.
+\htmlonly
+Go to the <a href="lists.html">next</a> section or return to the
+ <a href="index.html">index</a>.
+\endhtmlonly
+
*/