diff options
| author | albert-github <albert.tests@gmail.com> | 2014-08-15 13:25:25 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2014-08-15 13:25:25 (GMT) |
| commit | f8ceac63bdb52cf395207258c98ff0bcba35870a (patch) | |
| tree | 880acd6af86fb321545ccf2dd1f36105259eb106 /doc/commands.doc | |
| parent | 7d9d4320f5d183c4e1ebc87a316589c36f0afeed (diff) | |
| download | Doxygen-f8ceac63bdb52cf395207258c98ff0bcba35870a.zip Doxygen-f8ceac63bdb52cf395207258c98ff0bcba35870a.tar.gz Doxygen-f8ceac63bdb52cf395207258c98ff0bcba35870a.tar.bz2 | |
Create an easy possibility to take a snippet from the current file.
In case the snippet of code is in the current file one has to specify the name of the file and also see to it that the file is reachable through the EXAMPLE_PATH.
A use case is the case of a list of initial values here it is quite often more convenient to have the values listed in a 'nice' list than direct in the definition line.
With this patch it is possible to specify the name of the file where the snippet resides as: this
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 3 |
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 |