summaryrefslogtreecommitdiffstats
path: root/doc/markdown.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/markdown.doc')
-rw-r--r--doc/markdown.doc7
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/markdown.doc b/doc/markdown.doc
index 4df3efc..d0243dd 100644
--- a/doc/markdown.doc
+++ b/doc/markdown.doc
@@ -462,6 +462,13 @@ and in other sections that need to be processed without changes
\subsection mddox_code_blocks Code Block Indentation
+Markdown allows both a single tab or 4 spaces to start a code block.
+Since doxygen already replaces tabs by spaces before doing Markdown
+processing, the effect will only be same if TAB_SIZE in the config file
+has been set to 4. When it is set to a higher value spaces will be
+present in the code block. A lower value will prevent a single tab to be
+interpreted as the start of a code block.
+
With Markdown any block that is indented by 4 spaces (and 8 spaces
inside lists) is treated as a code block. This indentation amount
is absolute, i.e. counting from the start of the line.