Skip to content

Commit e84ada9

Browse files
authored
Merge pull request doxygen#12159 from albert-github/feature/bug_docu_settings
Incorrect handling of just a backslash in doxygen documentation / doxywizard
2 parents 311564e + 37a2de3 commit e84ada9

3 files changed

Lines changed: 6 additions & 4 deletions

File tree

addon/doxywizard/expert.cpp

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -567,6 +567,7 @@ QString Expert::getDocsForNode(const QDomElement &child) const
567567
// remove <br> at end
568568
regexp.setPattern(SA("<br> *$"));
569569
docs.replace(regexp,SA(" "));
570+
docs.replace(SA("(\\c \\\\)"),SA("(\\c JUST_WIZARD_BACKSLASH)"));
570571
// \c word -> <code>word</code>; word ends with ')', ',', '.' or ' '
571572
regexp.setPattern(SA("\\\\c[ ]+([^ \\)]+)\\)"));
572573
docs.replace(regexp,SA("<code>\\1</code>)"));
@@ -652,6 +653,7 @@ QString Expert::getDocsForNode(const QDomElement &child) const
652653
docs.replace(SA("-#"),SA("<br>-"));
653654
docs.replace(SA("\\# "),SA("# "));
654655
docs.replace(SA(" - "),SA("<br>-"));
656+
docs.replace(SA("JUST_WIZARD_BACKSLASH"),SA("\\"));
655657

656658
return docs.trimmed();
657659
}

doc/custcmd.dox

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ insert a newline as if a physical newline was in the original file.
4646

4747
Note when you need a literal `{` or `}` or `,` (or non default separator)
4848
in the value part of an alias you have to
49-
escape it by means of a backslash (`\`), this can lead to conflicts with the
49+
escape it by means of a backslash (\c \\), this can lead to conflicts with the
5050
commands \c \\{ and \c \\} for these it is advised to use the version \c @@{ and \c @@} or
5151
use a double escape (\c \\\\{ and \c \\\\})
5252

src/config.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ Go to the <a href="commands.html">next</a> section or return to the
596596
<docs doxyfile='0' documentation='0'>
597597
<![CDATA[
598598
When you need a literal `{` or `}` or `,` in the value part of an alias you have to
599-
escape them by means of a backslash, this can lead to conflicts with the
599+
escape them by means of a backslash (\c \\), this can lead to conflicts with the
600600
commands \c \\{ and \c \\} for these it is advised to use the version \c @{ and \c @} or
601601
use a double escape (\c \\\\{ and \c \\\\})
602602
]]>
@@ -612,7 +612,7 @@ Go to the <a href="commands.html">next</a> section or return to the
612612
<docs doxyfile='0' doxywizard='0'>
613613
<![CDATA[
614614
When you need a literal `{` or `}` or `,` in the value part of an alias you have to
615-
escape them by means of a backslash (`\`), this can lead to conflicts with the
615+
escape them by means of a backslash (\c \\), this can lead to conflicts with the
616616
commands \c \\{ and \c \\} for these it is advised to use the version \c @@{ and \c @@} or
617617
use a double escape (\c \\\\{ and \c \\\\})
618618
]]>
@@ -3095,7 +3095,7 @@ EXTRA_SEARCH_MAPPINGS = tagname1=loc1 tagname2=loc2 ...
30953095
<docs>
30963096
<![CDATA[
30973097
The \c LATEX_MAKEINDEX_CMD tag can be used to specify the command name to
3098-
generate index for \f$\mbox{\LaTeX}\f$. In case there is no backslash (`\`) as first character it
3098+
generate index for \f$\mbox{\LaTeX}\f$. In case there is no backslash (\c \\) as first character it
30993099
will be automatically added in the \f$\mbox{\LaTeX}\f$ code.
31003100
31013101
@note This tag is used in the generated output file (`.tex`).

0 commit comments

Comments
 (0)