summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPetr Prikryl <prikryl@atlas.cz>2014-09-24 06:10:59 (GMT)
committerPetr Prikryl <prikryl@atlas.cz>2014-09-24 06:10:59 (GMT)
commit84898eb601b4708ef4c310a517b99a4bf09f4954 (patch)
treef4f667a188d58644eb71631d470d4c7a485e5911 /doc
parentf8a304ecf96e7fc7d9e8a026f00cdf419e4bfc37 (diff)
parent2b6d6bf5ef71341af6afec1802c5991318c9692a (diff)
downloadDoxygen-84898eb601b4708ef4c310a517b99a4bf09f4954.zip
Doxygen-84898eb601b4708ef4c310a517b99a4bf09f4954.tar.gz
Doxygen-84898eb601b4708ef4c310a517b99a4bf09f4954.tar.bz2
Merge branch 'master' of https://github.com/doxygen/doxygen.git
Diffstat (limited to 'doc')
-rw-r--r--doc/commands.doc3
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 73eb842..1b3f2bd 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2147,7 +2147,8 @@ Commands for displaying examples
\addindex \\snippet
Where the \ref cmdinclude "\\include" command can be used to include
a complete file as source code, this command can be used to quote only
- a fragment of a source file.
+ a fragment of a source file. In case `this` is used as <file-name> the
+ current file is taken as file to take the snippet from.
For example, the putting the following command in the documentation,
references a snippet in file \c example.cpp residing in a subdirectory