diff options
| author | albert-github <albert.tests@gmail.com> | 2019-03-03 14:59:48 (GMT) |
|---|---|---|
| committer | albert-github <albert.tests@gmail.com> | 2019-03-03 14:59:48 (GMT) |
| commit | 8d13a1a9d0e6a5e4f50563b6d1b6840176e4a5cc (patch) | |
| tree | 971dfd0b77afc78f1a970fa889a829f18293ba17 /doc/commands.doc | |
| parent | abe69bd634fea9554a84d93e31db889ee589661f (diff) | |
| download | Doxygen-8d13a1a9d0e6a5e4f50563b6d1b6840176e4a5cc.zip Doxygen-8d13a1a9d0e6a5e4f50563b6d1b6840176e4a5cc.tar.gz Doxygen-8d13a1a9d0e6a5e4f50563b6d1b6840176e4a5cc.tar.bz2 | |
Show line numbers in "split" examples
With the commands like `\skip`, `\skipline` it is possible to show parts of a file for further explanation / tutorials. They can be started with `\include` or `\dontinclude` but in case `\include` specifies that the line numbers have to be shown they are only shown in the full example and not in the split up example
- show line numbers in split up example in case `lineno` is required
- add `lineno` option to `\dontinclude` so here also line numbers can be shown.
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 4 |
1 files changed, 3 insertions, 1 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 0e66c1d..b6c8f6b 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -2186,7 +2186,7 @@ Commands for displaying examples \htmlonly</p></center><p>\endhtmlonly <hr> -\section cmddontinclude \\dontinclude <file-name> +\section cmddontinclude \\dontinclude[{lineno}] <file-name> \addindex \\dontinclude This command can be used to parse a source file without actually @@ -2197,6 +2197,8 @@ Commands for displaying examples \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file. + You can add option `{lineno}` to enable line numbers for the included code if desired. + The class and member declarations and definitions inside the code fragment are 'remembered' during the parsing of the comment block that contained the \c \\dontinclude command. |