summaryrefslogtreecommitdiffstats
path: root/doc/custcmd.doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2018-09-14 13:55:30 (GMT)
committeralbert-github <albert.tests@gmail.com>2018-09-14 13:55:30 (GMT)
commit9766554d63dd85ba8857fe18eb7064c84b0231f6 (patch)
tree839c67d81ec98f75880ebe41d71c0d3b715bfabc /doc/custcmd.doc
parentaca45fd514cadc56ac277bd54f49604708ebbb5d (diff)
downloadDoxygen-9766554d63dd85ba8857fe18eb7064c84b0231f6.zip
Doxygen-9766554d63dd85ba8857fe18eb7064c84b0231f6.tar.gz
Doxygen-9766554d63dd85ba8857fe18eb7064c84b0231f6.tar.bz2
Usage of '{', '}' and ',' in ALIAS
Based on the stack overflow question: https://stackoverflow.com/questions/52314045/how-to-use-addtogroup-with-an-aliases-command/52314821#52314821 ALIASES += opengroup{1}="^^* \addtogroup \1_GROUP ^^ * \{ ^^" ALIASES += close="\}" /** \opengroup{LEVEL_1} */ // ...code statements... /** \close */ // opengroup Does not create a group due to the change of `\{` to just `}`, this behavior has been documented now.
Diffstat (limited to 'doc/custcmd.doc')
-rw-r--r--doc/custcmd.doc5
1 files changed, 5 insertions, 0 deletions
diff --git a/doc/custcmd.doc b/doc/custcmd.doc
index acc0224..02805da 100644
--- a/doc/custcmd.doc
+++ b/doc/custcmd.doc
@@ -44,6 +44,11 @@ Note that you can put `\n`'s in the value part of an alias to insert newlines
(in the resulting output). You can put `^^` in the value part of an alias to
insert a newline as if a physical newline was in the original file.
+Note when you need a literal `{` or `}` or `,` in the value part of an alias you have to
+escape them by means of a backslash (`\`), this can lead to conflicts with the
+commands \c \\{ and \c \\} for these it is advised to use the version \c @@{ and \c @@} or
+use a double escape (\c \\\\{ and \c \\\\})
+
Also note that you can redefine existing special commands if you wish.
Some commands, such as \ref cmdxrefitem "\\xrefitem" are designed to be used in