diff options
| author | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2003-07-25 12:37:34 (GMT) |
|---|---|---|
| committer | dimitri <dimitri@afe2bf4a-e733-0410-8a33-86f594647bc7> | 2003-07-25 12:37:34 (GMT) |
| commit | 5f27d7a0fcea0154d7d68cfb0812e097bb0deff1 (patch) | |
| tree | 5648b4ab8fb4ca6051647d47c3e8cf8d621e8782 /doc/commands.doc | |
| parent | 655c12fb6a950ed1b59bbcc29852ce20e45fdc6a (diff) | |
| download | Doxygen-5f27d7a0fcea0154d7d68cfb0812e097bb0deff1.zip Doxygen-5f27d7a0fcea0154d7d68cfb0812e097bb0deff1.tar.gz Doxygen-5f27d7a0fcea0154d7d68cfb0812e097bb0deff1.tar.bz2 | |
Release-1.3.3
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 950d4e5..073e3d9 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -391,8 +391,15 @@ doxygen. Unrecognized commands are treated as normal text. \addindex \\internal This command writes the message `For internal use only' to the output and - all text \e after a \c \\internal command until the end of the - comment block is ignored. + all text \e after an \c \\internal command until the end of the + comment block or the end of the section (whichever comes first) is + marked as "internal". + + If the \\internal command is put inside a section + (see for example \ref cmdsection "\\section") all subsection after the + command are considered to be internal as well. Only a new section at the + same level will be visible again. + You can use \ref cfg_internal_docs "INTERNAL_DOCS" in the config file to show or hide the internal documentation. |