summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2017-12-24 10:18:40 (GMT)
committerGitHub <noreply@github.com>2017-12-24 10:18:40 (GMT)
commit31ca2a48034dd1b0dc878dd992abb74ed5c5667f (patch)
treea8e396c69bc5149e21b1bf6684424fd200174622 /doc
parent722ddd602e24862a7e3a906fa0ffa4a71a1ed255 (diff)
parentd6801c4c5eaeebc5e14f5d1cd7c312ad82c1dbbd (diff)
downloadDoxygen-31ca2a48034dd1b0dc878dd992abb74ed5c5667f.zip
Doxygen-31ca2a48034dd1b0dc878dd992abb74ed5c5667f.tar.gz
Doxygen-31ca2a48034dd1b0dc878dd992abb74ed5c5667f.tar.bz2
Merge pull request #602 from albert-github/feature/bug_newline_alias
Physical newlines in ALIASES configuration tags.
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.