diff options
| author | Dimitri van Heesch <doxygen@gmail.com> | 2019-12-23 13:18:30 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-12-23 13:18:30 (GMT) |
| commit | 9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad (patch) | |
| tree | ffee9d6d930022c55710bc0931d0da6a77be27f0 /doc/markdown.doc | |
| parent | c9284a1aae6e876e0399c4757837bec3563751e2 (diff) | |
| parent | ecc4f838db18336c4afbc6dabb1a8edbc6d8bbd0 (diff) | |
| download | Doxygen-9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad.zip Doxygen-9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad.tar.gz Doxygen-9cafaedb50c8e430cc8c34ef44a84bc1dbcb64ad.tar.bz2 | |
Merge branch 'master' into spelling
Diffstat (limited to 'doc/markdown.doc')
| -rw-r--r-- | doc/markdown.doc | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/doc/markdown.doc b/doc/markdown.doc index 5edbaf9..883e831 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -193,10 +193,12 @@ code spans appear inline in a paragraph. An example: Use the `printf()` function. -To show a literal backtick inside a code span use double backticks, i.e. +To show a literal backtick or single quote inside a code span use double backticks, i.e. To assign the output of command `ls` to `var` use ``var=`ls```. + To assign the text 'text' to `var` use ``var='text'``. + See section \ref mddox_code_spans for more info how doxygen handles code spans slightly different than standard Markdown. @@ -606,6 +608,9 @@ In other words; a single quote cancels the special treatment of a code span wrapped in a pair of backtick characters. This extra restriction was added for backward compatibility reasons. +In case you want to have single quotes inside a code span, don't use +one backtick but two backticks around the code span. + \subsection mddox_lists Lists Extensions With Markdown two lists separated by an empty line are joined together into |