summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2012-02-25 15:18:56 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2012-02-25 15:18:56 (GMT)
commitcff8111ed33af6033bd188868964d92ea3503188 (patch)
tree2a7451abfd771d43ea2b3ac2443d94c3eb5cfee7 /doc
parent34d4ace6d4037862b6d280f1d7534292c714bf59 (diff)
downloadDoxygen-cff8111ed33af6033bd188868964d92ea3503188.zip
Doxygen-cff8111ed33af6033bd188868964d92ea3503188.tar.gz
Doxygen-cff8111ed33af6033bd188868964d92ea3503188.tar.bz2
Release-1.8.0
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc4
-rw-r--r--doc/markdown.doc24
2 files changed, 22 insertions, 6 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 0b758e2..27b18d6 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -539,8 +539,8 @@ Structural indicators
this command in a comment block of a define or variable, the
initializer is always hidden. The maximum number of initialization lines
can be changed by means of the configuration parameter
- \ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default value is
- 30.
+ \ref cfg_max_initializer_lines "MAX_INITIALIZER_LINES", the default
+ value is 30.
\sa section \ref cmdshowinitializer "\\showinitializer".
diff --git a/doc/markdown.doc b/doc/markdown.doc
index 07378ef..e057b53 100644
--- a/doc/markdown.doc
+++ b/doc/markdown.doc
@@ -169,10 +169,8 @@ Examples:
__double underscores__
-Note that unlike standard Markdown, doxygen will not touch internal underscores or
-stars, so the following will appear as-is:
-
- a_nice_identifier
+See section \ref mddox_emph_spans for more info how doxygen handles
+emphasis spans slightly different than standard Markdown.
\subsection md_codespan code spans
@@ -505,6 +503,24 @@ For Item1 the indentation is 4 (when treating the list marker as whitespace),
so the next paragraph "More text..." starts at the same indentation level
and is therefore not seen as a code block.
+\subsection mddox_emph_spans Emphasis limits
+
+Unlike standard Markdown, doxygen will not touch internal underscores or
+stars, so the following will appear as-is:
+
+ a_nice_identifier
+
+Futhermore, a `*` or `_` only starts an emphasis if
+- it is followed by an alphanumberical character, and
+- it is preceded by a space, newline, or one the following characters `<{([,:;`
+
+An emphasis ends if
+- it is not following by an alphanumerical character, and
+- it is not preceded by a space, newline, or one the following characters `({[<=+-\@`
+
+Lastly, the span of the emphasis is limited to a single paragraph.
+
+
\subsection mddox_code_spans Code Spans Limits
Note that unlike standard Markdown, doxygen leaves the following untouched.