diff options
Diffstat (limited to 'doc/commands.doc')
| -rw-r--r-- | doc/commands.doc | 158 |
1 files changed, 59 insertions, 99 deletions
diff --git a/doc/commands.doc b/doc/commands.doc index 1efd378..bbe5a9c 100644 --- a/doc/commands.doc +++ b/doc/commands.doc @@ -18,7 +18,9 @@ \section commands Special Commands All commands in the documentation start with a backslash (<b>\\</b>) or an -at-sign (<b>\@</b>). +at-sign (<b>\@</b>). If you prefer you can replace all commands starting with a +backslash below, by their counterparts that start with an at-sign. + Some commands have one or more arguments. Each argument has a certain range: <ul> @@ -41,67 +43,68 @@ documentation: \begin{CompactList} \endlatexonly <li> \refitem cmda \a -<li> \refitem cmdaddindex \addindex +<li> \refitem cmdaddindex \addindex <li> \refitem cmdanchor \anchor <li> \refitem cmdarg \arg -<li> \refitem cmdauthor \author +<li> \refitem cmdauthor \author <li> \refitem cmdb \b -<li> \refitem cmdbrief \brief -<li> \refitem cmdbug \bug +<li> \refitem cmdbrief \brief +<li> \refitem cmdbug \bug <li> \refitem cmdc \c -<li> \refitem cmdclass \class +<li> \refitem cmdclass \class <li> \refitem cmdcode \code -<li> \refitem cmddate \date -<li> \refitem cmddef \def -<li> \refitem cmddefgroup \defgroup -<li> \refitem cmddontinclude \dontinclude +<li> \refitem cmddate \date +<li> \refitem cmddef \def +<li> \refitem cmddefgroup \defgroup +<li> \refitem cmddeprecated \deprecated +<li> \refitem cmddontinclude \dontinclude <li> \refitem cmde \e <li> \refitem cmdendcode \endcode <li> \refitem cmdendhtmlonly \endhtmlonly <li> \refitem cmdendlatexonly \endlatexonly <li> \refitem cmdendlink \endlink <li> \refitem cmdendverbatim \endverbatim -<li> \refitem cmdenum \enum -<li> \refitem cmdexample \example -<li> \refitem cmdexception \exception +<li> \refitem cmdenum \enum +<li> \refitem cmdexample \example +<li> \refitem cmdexception \exception <li> \refitem cmdfdollar \f$ <li> \refitem cmdfbropen \f[ <li> \refitem cmdfbrclose \f] -<li> \refitem cmdfile \file -<li> \refitem cmdfn \fn +<li> \refitem cmdfile \file +<li> \refitem cmdfn \fn <li> \refitem cmdhtmlonly \htmlonly -<li> \refitem cmdimage \image -<li> \refitem cmdinclude \include -<li> \refitem cmdingroup \ingroup +<li> \refitem cmdimage \image +<li> \refitem cmdinclude \include +<li> \refitem cmdingroup \ingroup <li> \refitem cmdinternal \internal <li> \refitem cmdlatexonly \latexonly -<li> \refitem cmdline \line -<li> \refitem cmdlink \link -<li> \refitem cmdmainpage \mainpage +<li> \refitem cmdline \line +<li> \refitem cmdlink \link +<li> \refitem cmdmainpage \mainpage <li> \refitem cmdnamespace \namespace -<li> \refitem cmdoverload \overload -<li> \refitem cmdpage \page -<li> \refitem cmdpar \par -<li> \refitem cmdparam \param -<li> \refitem cmdref \ref -<li> \refitem cmdrelates \relates -<li> \refitem cmdreturn \return +<li> \refitem cmdoverload \overload +<li> \refitem cmdpage \page +<li> \refitem cmdpar \par +<li> \refitem cmdparam \param +<li> \refitem cmdref \ref +<li> \refitem cmdrelates \relates +<li> \refitem cmdreturn \return <li> \refitem cmdretval \retval -<li> \refitem cmdsa \sa -<li> \refitem cmdsection \section -<li> \refitem cmdskip \skip -<li> \refitem cmdskipline \skipline -<li> \refitem cmdstruct \struct -<li> \refitem cmdsubsection \subsection +<li> \refitem cmdsa \sa +<li> \refitem cmdsection \section +<li> \refitem cmdskip \skip +<li> \refitem cmdskipline \skipline +<li> \refitem cmdstruct \struct +<li> \refitem cmdsubsection \subsection <li> \refitem cmdthrow \throw <li> \refitem cmdtypedef \typedef -<li> \refitem cmdunion \union +<li> \refitem cmdunion \union <li> \refitem cmduntil \until -<li> \refitem cmdvar \var +<li> \refitem cmdvar \var <li> \refitem cmdverbatim \verbatim <li> \refitem cmdverbinclude \verbinclude -<li> \refitem cmdversion \version -<li> \refitem cmdwarning \warning +<li> \refitem cmdversion \version +<li> \refitem cmdwarning \warning <li> \refitem cmddollar \$ <li> \refitem cmdat \@ <li> \refitem cmdbackslash \\ @@ -147,7 +150,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdcode \code - \addindex \\code + \addindex \code Starts a block of code. A code block is treated differently from ordinary text. It is interpreted as C/C++ code. The names of the classes and members that are documented are automatically replaced by @@ -489,8 +492,6 @@ Doxygen. Unrecognized commands are treated as normal text. for the corresponding HTML documentation that is generated by Doxygen. \endhtmlonly - \sa Section \ref cmdjdauthor "@author". - <hr> \subsection cmdbrief \brief {brief description} @@ -504,9 +505,9 @@ Doxygen. Unrecognized commands are treated as normal text. blank line or another sectioning command is encountered. If multiple \\brief commands are present they will be joined. See section \ref cmdauthor "\\author" for an example. - - \sa Section \ref cmdjdshort "@short". + Synonymous to \\short. + <hr> \subsection cmdbug \bug { bug description } @@ -537,7 +538,13 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. - \sa Section \ref cmdjddate "@date". +<hr> +\subsection cmddeprecated \deprecated { description } + + \addindex \deprecated + Starts a paragraph indicating that this documentation block belongs to + a deprecated entity. Can be used to describe alternatives, + expected life span, etc. <hr> \subsection cmdpar \par (paragraph title) { paragraph } @@ -573,8 +580,6 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdparam "@param". - <hr> \subsection cmdexception \exception <exception-object> { exception description } @@ -593,13 +598,11 @@ Doxygen. Unrecognized commands are treated as normal text. \par Note: the tag \\exceptions is a synonym for this tag. - \sa Section \ref cmdjdexception "@exception". - <hr> \subsection cmdthrow \throw <exception-object> { exception description } \addindex \throw - Equivalent to \\exception (see section \ref cmdexception "\\exception"). + Synonymous to \\exception (see section \ref cmdexception "\\exception"). \par Note: the tag \\throws is a synonym for this tag. @@ -616,9 +619,6 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdfn "\\fn" for an example. - \sa Section \ref cmdjdreturn "@return". - - <hr> \subsection cmdretval \retval <return value> { description } @@ -633,8 +633,6 @@ Doxygen. Unrecognized commands are treated as normal text. The \\retval description ends when a blank line or some other sectioning command is encountered. - \sa Section \ref cmdjdretval "@retval". - <hr> \subsection cmdsa \sa { references } @@ -646,8 +644,10 @@ Doxygen. Unrecognized commands are treated as normal text. may be selected by including a parenthesized list of argument types after the method. - \sa section \ref autolink "\\autolink" for information on how to create links to objects - and section \ref cmdjdsee "@see" for the JavaDoc version of this command. + Synonymous to \\see. + + \sa section \ref autolink "\\autolink" for information on how to create links + to objects. <hr> \subsection cmdversion \version { version number } @@ -664,8 +664,6 @@ Doxygen. Unrecognized commands are treated as normal text. sectioning command is encountered. See section \ref cmdauthor "\\author" for an example. - \sa Section \ref cmdjdversion "@version". - <hr> \subsection cmdwarning \warning { warning message } @@ -1024,7 +1022,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdfdollar \f$ - \addindex \\f$ + \addindex \f$ Marks the start and end of an in-text formula. \sa section \ref formulas "formulas" for an example. @@ -1032,7 +1030,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdfbropen \f[ - \addindex \\f[ + \addindex \f[ Marks the start of a long formula that is displayed centered on a separate line. @@ -1041,7 +1039,7 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> \subsection cmdfbrclose \f] - \addindex \\f] + \addindex \f] Marks the end of a long formula that is displayed centered on a separate line. @@ -1205,44 +1203,6 @@ Doxygen. Unrecognized commands are treated as normal text. <hr> <h2>\htmlonly <center> --- \endhtmlonly - Commands included for JavaDoc compatibility - \htmlonly --- </center>\endhtmlonly</h2> - -The following command JavaDoc command are support. - -\subsection cmdjdauthor @author { list of authors } - \addindex @author - Equivalent to \\author (see section \ref cmdauthor "\\author"). -\subsection cmdjddate @date { date description } - \addindex @date - Equivalent to \\date (see section \ref cmddate "\\date"). -\subsection cmdjdparam @param <parameter-name> { parameter-description } - \addindex @param - Equivalent to \\param (see section \ref cmdparam "\\param"). -\subsection cmdjdexception @exception <exception-object> { exception-description } - \addindex @exception - Equivalent to \\exception (see section \ref cmdexception "\\exception"). - Also synonymous to \@exceptions and \\exceptions. -\subsection cmdjdthrows @throw <exception-object> { exception-description } - Equivalent to \\throw (see section \ref cmdthrow "\\throw"). - Also synonymous to \@exception and \\exception. -\subsection cmdjdreturn @return { description of the return value } - \addindex @return - Equivalent to \\return (see section \ref cmdreturn "\\return"). -\subsection cmdjdretval @retval <return value name> { return value description } - \addindex @retval - Equivalent to \\retval (see section \ref cmdretval "\\retval"). -\subsection cmdjdsee @see { references } - \addindex @see - Equivalent to \\sa (see section \ref cmdsa "\\sa"). -\subsection cmdjdshort @short { brief description } - \addindex @short - Equivalent to \\brief (see section \ref cmdbrief "\\brief"). -\subsection cmdjdversion @version { version number } - \addindex @version - Equivalent to \\version (see section \ref cmdversion "\\version"). - -<h2>\htmlonly <center> --- \endhtmlonly Commands included for Qt compatibility \htmlonly --- </center>\endhtmlonly</h2> |