diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 177 |
1 files changed, 131 insertions, 46 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index a9973ce..f04b543 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -106,6 +106,8 @@ documentation: \refitem cmdheaderfile \\headerfile \refitem cmdhidecallergraph \\hidecallergraph \refitem cmdhidecallgraph \\hidecallgraph +\refitem cmdhiderefby \\hiderefby +\refitem cmdhiderefs \\hiderefs \refitem cmdhideinitializer \\hideinitializer \refitem cmdhtmlinclude \\htmlinclude \refitem cmdhtmlonly \\htmlonly @@ -174,6 +176,8 @@ documentation: \refitem cmdsee \\see \refitem cmdshort \\short \refitem cmdshowinitializer \\showinitializer +\refitem cmdshowrefby \\showrefby +\refitem cmdshowrefs \\showrefs \refitem cmdsince \\since \refitem cmdskip \\skip \refitem cmdskipline \\skipline @@ -214,6 +218,7 @@ documentation: \refitem cmdperc \\\% \refitem cmdquot \\\" \refitem cmdchardot \\\. +\refitem cmdcolon \: \refitem cmddcolon \:: \refitem cmdpipe \\| \refitem cmdndash \\\-- @@ -306,7 +311,7 @@ Structural indicators When this command is put in a comment block of a function or method and \ref cfg_have_dot "HAVE_DOT" is set to \c YES, then doxygen will generate a caller graph for that function (provided the implementation of the - function or method calls other documented functions). The caller graph will be + function or method is called by other documented functions). The caller graph will be generated regardless of the value of \ref cfg_caller_graph "CALLER_GRAPH". \note The completeness (and correctness) of the caller graph depends on the doxygen code parser which is not perfect. @@ -333,6 +338,74 @@ Structural indicators option \ref cfg_caller_graph "CALLER_GRAPH" <hr> +\section cmdshowrefby \\showrefby + + \addindex \\showrefby + When this command is put in a comment block of a function, method or variable, + then doxygen will generate an overview for that function, method, variable of + the, documented, funcions and methods that call / use it. + The overview will be generated regardless of the value of + \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefs "\\showrefs", + section \ref cmdhiderefby "\\hiderefby", + section \ref cmdhiderefs "\\hiderefs" and + option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" + +<hr> +\section cmdhiderefby \\hiderefby + + \addindex \\hiderefby + When this command is put in a comment block of a function, method or variable + then doxygen will not generate an overview for that function, method or + variable of the functions and methods that call / use it. + The overview will not be generated regardless of the value of + \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefs "\\showrefs", + section \ref cmdshowrefby "\\showrefby", + section \ref cmdhiderefs "\\hiderefs" and + option \ref cfg_referenced_by_relation "REFERENCED_BY_RELATION" + +<hr> +\section cmdshowrefs \\showrefs + + \addindex \\showrefs + When this command is put in a comment block of a function or method, + then doxygen will generate an overview for that function or method of the + functions and methods that call it. + The overview will be generated regardless of the value of + \ref cfg_references_relation "REFERENCES_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefby "\\showrefby", + section \ref cmdhiderefby "\\hiderefby", + section \ref cmdhiderefs "\\hiderefs" and + option \ref cfg_references_relation "REFERENCES_RELATION" + +<hr> +\section cmdhiderefs \\hiderefs + + \addindex \\hiderefs + When this command is put in a comment block of a function or method + and then doxygen will not generate an overview for that function or method of + the functions and methods that call it. + The overview will not be generated regardless of the value of + \ref cfg_references_relation "REFERENCES_RELATION". + \note The completeness (and correctness) of the overview depends on the + doxygen code parser which is not perfect. + + \sa section \ref cmdshowrefs "\\showrefs", + section \ref cmdshowrefby "\\showrefby", + section \ref cmdhiderefby "\\hiderefby" and + option \ref cfg_references_relation "REFERENCES_RELATION" + +<hr> \section cmdcategory \\category <name> [<header-file>] [<header-name>] \addindex \\category @@ -442,14 +515,15 @@ Structural indicators \endlatexonly </p><hr> -\section cmdexample \\example <file-name> +\section cmdexample \\example[{lineno}] <file-name> \addindex \\example Indicates that a comment block contains documentation for a source code - example. The name of the source file is \<file-name\>. The text of - this file will be included in the documentation, just after the - documentation contained in the comment block. All examples are placed - in a list. The source code is scanned for documented members and classes. + example. The name of the source file is \<file-name\>. + The contents of this file will be included in the documentation, just after the + documentation contained in the comment block. + You can add option `{lineno}` to enable line numbers for the example if desired. + All examples are placed in a list. The source code is scanned for documented members and classes. If any are found, the names are cross-referenced with the documentation. Source files or directories can be specified using the \ref cfg_example_path "EXAMPLE_PATH" @@ -1887,7 +1961,7 @@ Commands to create links \section cmdaddindex \\addindex (text) \addindex \\addindex - This command adds (text) to the \LaTeX index. + This command adds (text) to the \LaTeX , DocBook and RTF index. <hr> \section cmdanchor \\anchor <word> @@ -2033,7 +2107,7 @@ Make sure you have first read \ref intro "the introduction". \addindex \\tableofcontents Creates a table of contents at the top of a page, listing all sections and subsections in the page. The `option` can be `HTML` or `LaTeX` - or `XML`. When a `level` is specified this means the maximum nesting level + or `XML` or `DocBook`. When a `level` is specified this means the maximum nesting level that is shown. The value of `level` should be in the range 1..5, values outside this range are considered to be 5. In case no `level` is specified `level` is set to 5 (show all) @@ -2151,16 +2225,12 @@ Commands for displaying examples for the corresponding \mbox{\LaTeX} documentation that is generated by doxygen. \endlatexonly - Alternatively, the \ref cmdsnippet "\\snippet" command can be used to - include only a fragment of a source file. For this to work the - fragment has to be marked. - \sa sections \ref cmdline "\\line", \ref cmdskip "\\skip", \ref cmdskipline "\\skipline", \ref cmduntil "\\until", and \ref cmdinclude "\\include". </p><hr> -\section cmdinclude \\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. @@ -2194,33 +2264,38 @@ Commands for displaying examples \note Doxygen's special commands do not work inside blocks of code. It is allowed to nest C-style comments inside a code block though. + You can add option `{lineno}` to enable line numbers for the included code if desired. + + You can add option `{doc}` to treat the file as documentation rather than code. + + \note Some that when using the `{doc}` option, + commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with + this command due to the moment of parsing. + + \note The included documentation should not have comment signs in it as they will appear + in the documentation as well. + \sa sections \ref cmdexample "\\example", \ref cmddontinclude "\\dontinclude", - \ref cmdverbatim "\\verbatim" and \ref cmdincludedoc "\\includedoc". + \ref cmdverbatim "\\verbatim", \ref cmdincludedoc "\\includedoc", and + \ref cmdsnippet "\\snippet". <hr> \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" and \ref cmdsnippetlineno "\\snippetlineno". + \sa sections \ref cmdinclude "\\include{lineno}". <hr> \section cmdincludedoc \\includedoc <file-name> \addindex \\includedoc - This command works the same way as \ref cmdinclude "\\include", but it will include - the content of the file as if it were at the place where this command is called. - The result is that the content is parsed by doxygen and placed in the documentation. - - \note Some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with - this command due to the moment of parsing. - - \note The included documentation should not have comment signs in it as they will appear - in the documentation as well. + 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 ) @@ -2278,7 +2353,7 @@ Commands for displaying examples See section \ref cmddontinclude "\\dontinclude" for an example. <hr> -\section cmdsnippet \\snippet <file-name> ( block_id ) +\section cmdsnippet \\snippet[{lineno|doc}] <file-name> ( block_id ) \addindex \\snippet Where the \ref cmdinclude "\\include" command can be used to include @@ -2321,34 +2396,37 @@ Commands for displaying examples Note also that the [block_id] markers should appear exactly twice in the source file. + You can add option `{lineno}` to enable line numbers for the snippet if desired. + + You can add option `{doc}` to treat the file as documentation rather than code. + + \note Some that when using the `{doc}` option, + commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with + this command due to the moment of parsing. + + \note The included documentation should not have comment signs in it as they will appear + in the documentation as well. + see section \ref cmddontinclude "\\dontinclude" for an alternative way to include fragments of a source file that does not require markers. - \sa section \ref cmdsnippetdoc "\\snippetdoc" and \ref cmdsnippetlineno "\\snippetlineno". <hr> \section cmdsnippetlineno \\snippetlineno <file-name> ( block_id ) \addindex \\snippetlineno - This command works the same way as \ref cmdsnippet "\\snippet", but will add line - numbers to the included snippet. + This command is obsolete and is still supported for backward compatibility reasons, + it works the same way as \ref cmdsnippet "\\snippet{lineno}" - \sa sections \ref cmdsnippet "\\snippet" and \ref cmdincludelineno "\\includelineno". + \sa sections \ref cmdsnippet "\\snippet{lineno}" <hr> \section cmdsnippetdoc \\snippetdoc <file-name> ( block_id ) \addindex \\snippetdoc - This command works the same way as \ref cmdsnippet "\\snippet", but it will include - the content of the file between the `block-id`s as if it were at the place where this command is called. - The result is that the content is parsed by doxygen and placed in the documentation. - - \note Some commands like \ref cmdcond "\\cond" and \ref cmdif "\\if" don't work with - this command due to the moment of parsing. - - \note The included documentation should not have comment signs in it as they will appear - in the documentation as well. + This command is obsolete and is still supported for backward compatibility reasons, + it works the same way as \ref cmdsnippet "\\snippet{doc}" - \sa section \ref cmdsnippet "\\snippet" and \ref cmdincludedoc "\\includedoc". + \sa section \ref cmdsnippet "\\snippet{doc}" and \ref cmdinclude "\\include{doc}". <hr> \section cmduntil \\until ( pattern ) @@ -2603,7 +2681,7 @@ only copy the detailed documentation, not the brief description. \addindex \\docbookonly Starts a block of text that will be verbatim included in the - generated docbook documentation only. The block ends with a + generated DocBook documentation only. The block ends with a \ref cmdenddocbookonly "\\enddocbookonly" command. \sa section \ref cmdmanonly "\\manonly", @@ -3077,7 +3155,7 @@ class Receiver spaces. The quotes are stripped before the caption is displayed. The fourth argument is also optional and can be used to specify the - width or height of the image. This can be useful for \LaTeX or docbook output + width or height of the image. This can be useful for \LaTeX or DocBook output (i.e. format=<code>latex</code> or format=<code>docbook</code>). \anchor image_sizeindicator \par Size indication The \c sizeindication can specify the width or height to be used (or a combination). @@ -3279,7 +3357,7 @@ class Receiver \addindex \\\@ This command writes an at-sign (\c \@) to the output. The at-sign has to be escaped in some cases - because doxygen uses it to detect JavaDoc commands. + because doxygen uses it to detect Javadoc commands. <hr> \section cmdtilde \\~[LanguageId] @@ -3361,6 +3439,14 @@ class Receiver the start of a line. <hr> +\section cmdcolon \: + + \addindex \\: + This command writes a single colon (\c \:) to the output. This + character sequence has to be escaped in some cases, because it is used + to define `emoji` see also \ref emojisup "Emoji support". + +<hr> \section cmddcolon \\:: \addindex \\:: @@ -3423,4 +3509,3 @@ Go to the <a href="htmlcmds.html">next</a> section or return to the \endhtmlonly */ - |