summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2018-08-19 19:52:45 (GMT)
committerGitHub <noreply@github.com>2018-08-19 19:52:45 (GMT)
commit2f24b4124346aa033864ddc50c25c24765815a16 (patch)
tree725c2524fc2a7cbff93e4eb60d737fdb8dd560f9
parentcf5f1ed593fefcef2cceee69dec44e7daa5e8c12 (diff)
parent731758537f45b602b000cb081d8b642fc54141da (diff)
downloadDoxygen-2f24b4124346aa033864ddc50c25c24765815a16.zip
Doxygen-2f24b4124346aa033864ddc50c25c24765815a16.tar.gz
Doxygen-2f24b4124346aa033864ddc50c25c24765815a16.tar.bz2
Merge pull request #6453 from albert-github/feature/bug_docu_lineno_doc
Documentation correction include command with options
-rw-r--r--doc/commands.doc8
1 files changed, 4 insertions, 4 deletions
diff --git a/doc/commands.doc b/doc/commands.doc
index 2e51d79..a630aac 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -2157,7 +2157,7 @@ Commands for displaying examples
\ref cmdinclude "\\include".
</p><hr>
-\section cmdinclude[{lineno|doc}] \\include <file-name>
+\section cmdinclude \\include[{lineno|doc}] <file-name>
\addindex \\include
This command can be used to include a source file as a block of code.
@@ -2210,8 +2210,8 @@ Commands for displaying examples
\section cmdincludelineno \\includelineno <file-name>
\addindex \\includelineno
- This command works the same way as \ref cmdinclude "\\include", but will add line
- numbers to the included file.
+ This command is obsolete and is still supported for backward compatibility reasons,
+ it works the same way as \ref cmdinclude "\\include{lineno}"
\sa sections \ref cmdinclude "\\include{lineno}".
@@ -2222,7 +2222,7 @@ Commands for displaying examples
This command is obsolete and is still supported for backward compatibility reasons,
it works the same way as \ref cmdinclude "\\include{doc}"
- \sa section \ref cmdinclude "\\include".
+ \sa section \ref cmdinclude "\\include{doc}".
<hr>
\section cmdline \\line ( pattern )