Browse files

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
  • Loading branch information...
albert-github committed Aug 15, 2014
1 parent 7d9d432 commit f8ceac63bdb52cf395207258c98ff0bcba35870a
Showing with 3 additions and 1 deletion.
  1. +2 −1 doc/commands.doc
  2. +1 −0 src/docparser.cpp
@@ -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
@@ -5218,6 +5218,7 @@ void DocPara::handleInclude(const QCString &cmdName,DocInclude::Type t)
QCString blockId;
if (t==DocInclude::Snippet)
if (fileName == "this") fileName=g_fileName;

0 comments on commit f8ceac6

Please sign in to comment.