summaryrefslogtreecommitdiffstats
path: root/doc/commands.doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc/commands.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