diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 36 |
1 files changed, 30 insertions, 6 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index b56ebf3..e8cf0a6 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -466,10 +466,34 @@ Structural indicators The \<header-name\> argument can be used to overwrite the name of the link that is used in the class documentation to something other than \<header-file\>. This can be useful if the include name is not located - on the default include path (like \<X11/X.h\>). With the \<header-name\> + on the default include path (like \<X11/X.h\>). + + With the \<header-name\> argument you can also specify how the include statement should look like, - by adding either quotes or sharp brackets around the name. - Sharp brackets are used if just the name is given. + by adding either double quotes or sharp brackets around the name. + By default sharp brackets are used if just the name is given. + + If a pair of double quotes is given for either the header-file or + header-name argument, the current file (in which the command was found) + will be used but with quotes. So for a comment block with a \\headerfile + command inside a file test.h, the following three commands are equivalent: + \verbatim + \headerfile test.h "test.h" + \headerfile test.h "" + \headerfile "" \endverbatim + To get sharp brackets you do not need to specify anything, + but if you want to be explicit you could use any of the following: + \verbatim + \headerfile test.h <test.h> + \headerfile test.h <> + \headerfile <> \endverbatim + + To globally reverse the default include representation to + local includes you can set + \ref cfg_force_local_includes "FORCE_LOCAL_INCLUDES" to \c YES. + + To disable the include information altogether set + \ref cfg_show_include_files "SHOW_INCLUDE_FILES" to \c NO. <hr> \section cmdhideinitializer \\hideinitializer @@ -2467,12 +2491,12 @@ class Receiver prevent auto-linking to word that is also a documented class or struct. <hr> -\section cmdquot \\\" +\section cmdquot \\" \addindex \\\" This command writes the \" character to the output. This - character has to be escaped in some cases, because it is used to - prevent auto-linking to word that is also a documented class or struct. + character has to be escaped in some cases, because it is used in pairs + to indicate an unformated text fragment. <hr> \htmlonly <center> \endhtmlonly |