diff options
Diffstat (limited to 'doc/markdown.doc')
| -rw-r--r-- | doc/markdown.doc | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/doc/markdown.doc b/doc/markdown.doc index 6c483e1..bbadd9d 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -189,7 +189,7 @@ emphasis / strikethrough spans slightly different than standard Markdown / GitHu \subsection md_codespan code spans -To indicate a span of code, you should wrap it in backticks (`). Unlike code blocks, +To indicate a span of code, you should wrap it in backticks (`` ` ``). Unlike code blocks, code spans appear inline in a paragraph. An example: Use the `printf()` function. @@ -455,9 +455,11 @@ The curly braces and dot are optional by the way. Another way to denote fenced code blocks is to use 3 or more backticks (```): - ``` - also a fenced code block - ``` +~~~~~~{.unparsed} +``` +also a fenced code block +``` +~~~~~~ For the image formats `dot`, `msc` and `plantuml` the fenced block will be shown as an image provided the image format is enabled (see \ref cfg_have_dot "HAVE_DOT" and @@ -633,7 +635,7 @@ and is therefore not seen as a code block. \subsection mddox_emph_spans Emphasis and strikethrough limits -Unlike standard Markdown and Github Flavored Markdown doxygen will not touch internal underscores or +Unlike standard Markdown and GitHub Flavored Markdown doxygen will not touch internal underscores or stars or tildes, so the following will appear as-is: a_nice_identifier @@ -649,7 +651,7 @@ An emphasis or a strikethrough ends if The span of the emphasis or strikethrough is limited to a single paragraph. Lastly, note that when you want to put emphasis on a piece of text at the start of a line -by means of `*`s within a C-style doxygen comment block (i.e. `/‍** ... *‍/`) +by means of `*`s within a C-style doxygen comment block (i.e. `/``** ... *``/`) that does not have leading `*` as column "lineup", then doxygen will see the sequence of `*`s at the beginning of the line as "lineup" and not as emphasis. So the following will not render as bold: |