summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authoralbert-github <albert.tests@gmail.com>2017-09-09 13:21:23 (GMT)
committeralbert-github <albert.tests@gmail.com>2017-09-09 13:21:23 (GMT)
commitd6801c4c5eaeebc5e14f5d1cd7c312ad82c1dbbd (patch)
treedb94e67eb4fc6b76746f3ae4336a8fcd71f86e39 /doc
parentddae91901de9509e8caff4181230535f236c5897 (diff)
downloadDoxygen-d6801c4c5eaeebc5e14f5d1cd7c312ad82c1dbbd.zip
Doxygen-d6801c4c5eaeebc5e14f5d1cd7c312ad82c1dbbd.tar.gz
Doxygen-d6801c4c5eaeebc5e14f5d1cd7c312ad82c1dbbd.tar.bz2
Physical newlines in ALIASES configuration tags.
Some commands read input till the end of the physical line. In case these commands are used in an alias the rest of the line is lost / gives not the required results. This patch creates the possibility to have physical newlines in ALIASES. See also: https://stackoverflow.com/questions/46050789/doxygen-alias-with-multiple-commands
Diffstat (limited to 'doc')
-rw-r--r--doc/custcmd.doc4
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/custcmd.doc b/doc/custcmd.doc
index 8ac2a65..de9a30d 100644
--- a/doc/custcmd.doc
+++ b/doc/custcmd.doc
@@ -40,7 +40,9 @@ The simplest form of an alias is a simple substitution of the form
put the command `\sideeffect` (or `@sideeffect`) in the documentation, which
will result in a user-defined paragraph with heading <b>Side Effects:</b>.
-Note that you can put `\n`'s in the value part of an alias to insert newlines.
+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.
Also note that you can redefine existing special commands if you wish.