commands.doc

doxygen(一个自动从源代码生成文档的工具)的源代码

  Click <a href="$(DOXYGEN_DOCDIR)/examples/par/html/class_test.html">here</a> 
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly

<hr>
\subsection cmdparam \param <parameter-name> { parameter description }

  \addindex \param
  Starts a parameter description for a function parameter with name 
  \<parameter-name\>. Followed by a description of the parameter. 
  The existence of the parameter is not checked.
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\param commands will be joined into a single paragraph.
  Each parameter description will start on a new line.
  The \\param description ends when a blank line or some other 
  sectioning command is encountered. See section \ref cmdfn "\\fn" for an 
  example.

<hr>
\subsection cmdpost \post { description of the postcondition }

  \addindex \post
  Starts a paragraph where the postcondition of an entity can be described.
  The paragraph will be indented. 
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\post commands will be joined into a single paragraph.
  Each postcondition will start on a new line.
  Alternatively, one \\post command may mention 
  several postconditions. The \\post command ends when a blank line or some other 
  sectioning command is encountered.

<hr>
\subsection cmdpre \pre { description of the precondition }

  \addindex \pre
  Starts a paragraph where the precondition of an entity can be described.
  The paragraph will be indented. 
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\pre commands will be joined into a single paragraph.
  Each precondition will start on a new line.
  Alternatively, one \\pre command may mention 
  several preconditions. The \\pre command ends when a blank line or some other 
  sectioning command is encountered.
  
<hr>
\subsection cmdremarks \remarks { remark text }

  \addindex \remarks
  Starts a paragraph where one or more remarks may be entered. 
  The paragraph will be indented. 
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\remark commands will be joined into a single paragraph.
  Each remark will start on a new line.
  Alternatively, one \\remark command may mention 
  several remarks. The \\remark command ends when a blank line or some other 
  sectioning command is encountered. 

<hr>
\subsection cmdreturn \return { description of the return value }

  \addindex \return
  Starts a return value description for a function. 
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\return commands will be joined into a single paragraph.
  The \\return description ends when a blank line or some other 
  sectioning command is encountered. See section \ref cmdfn "\\fn" for an 
  example.
  
<hr>
\subsection cmdretval \retval <return value> { description }

  \addindex \retval
  Starts a return value description for a function with name 
  \<return value\>. Followed by a description of the return value. 
  The text of the paragraph that forms the description has no special
  internal structure. All visual enhancement commands may be used inside the 
  paragraph.
  Multiple adjacent \\retval commands will be joined into a single paragraph.
  Each return value description will start on a new line.
  The \\retval description ends when a blank line or some other 
  sectioning command is encountered. 

<hr>
\subsection cmdsa \sa { references }

  \addindex \sa
  Starts a paragraph where one or more cross-references to classes, 
  functions, methods, variables, files or URL may be specified.
  Two names joined by either <code>::</code> or <code>\#</code> 
  are understood as referring to a class and one of its members. 
  One of several overloaded methods or constructors 
  may be selected by including a parenthesized list of argument types after 
  the method name. 

  Synonymous to \\see.

  \sa section \ref autolink "autolink" for information on how to create links 
      to objects.

<hr>
\subsection cmdsince \since { text }

  \addindex \since
  This tag can be used to specify since when (version or time) an
  entity is available. The paragraph that follows \\since does not have any
  special internal structure. All visual enhancement commands may be 
  used inside the paragraph. The \\since description ends when a blank 
  line or some other sectioning command is encountered. 

<hr>
\subsection cmdtest \test { paragraph describing a test case }

  \addindex \test
  Starts a paragraph where a test case can be described. 
  The description will also add the test case to a separate test list. 
  The two instances of the description will be cross-referenced.
  Each test case in the test list will be preceded by a header that
  indicates the origin of the test case.

<hr>
\subsection cmdthrow \throw <exception-object> { exception description }

  \addindex \throw
  Synonymous to \\exception (see section \ref cmdexception "\\exception").

  \par Note: 
  the tag \\throws is a synonym for this tag.

<hr>
\subsection cmdtodo \todo { paragraph describing what is to be done }

  \addindex \todo
  Starts a paragraph where a TODO item is described. 
  The description will also add an item to a separate TODO list. 
  The two instances of the description will be cross-referenced.
  Each item in the TODO list will be preceded by a header that
  indicates the origin of the item.

<hr>
\subsection cmdversion \version { version number }

  \addindex \version
  Starts a paragraph where one or more version strings may be entered. 
  The paragraph will be indented. 
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\version commands will be joined into a single paragraph.
  Each version description will start on a new line.
  Alternatively, one \\version command may mention 
  several version strings. 
  The \\version command ends when a blank line or some other 
  sectioning command is encountered. See section \ref cmdauthor "\\author" 
  for an example.
 
<hr>
\subsection cmdwarning \warning { warning message }

  \addindex \warning
  Starts a paragraph where one or more warning messages may be entered. 
  The paragraph will be indented. 
  The text of the paragraph has no special internal structure. All visual
  enhancement commands may be used inside the paragraph.
  Multiple adjacent \\warning commands will be joined into a single paragraph.
  Each warning description will start on a new line.
  Alternatively, one \\warning command may mention 
  several warnings. The \\warning command ends when a blank line or some other 
  sectioning command is encountered. See section \ref cmdauthor "\\author" 
  for an example.

<hr>
<h2>\htmlonly <center> --- \endhtmlonly 
    Commands to create links
    \htmlonly --- </center>\endhtmlonly</h2>

\subsection cmdaddindex \addindex (text)

  \addindex \addindex
  This command adds (text) to the \f$\mbox{\LaTeX}\f$ index.

<hr>
\subsection cmdanchor \anchor <word>

  \addindex \anchor
  This command places an invisible, named anchor into the documentation
  to which you can refer with the \\ref command.

  \sa section \ref cmdref "\\ref".

<hr>
\subsection cmdendlink \endlink

  \addindex \endlink 
  This command ends a link that is started with the \\link command.
  
  \sa section \ref cmdlink "\\link".

<hr>
\subsection cmdlink \link <link-object> 

  \addindex \link
  The links that are automatically generated by doxygen always have the
  name of the object they point to as link-text. 

  The \\link command can be used to create a link to an object (a file, 
  class, or member) with a user specified link-text. 
  The link command should end with an \\endlink command. All text between
  the \\link and \\endlink commands serves as text for a link to 
  the \<link-object\> specified as the first argument of \\link.
  
  See section \ref autolink "autolink" for more information on automatically 
  generated links and valid link-objects.

<hr>
\subsection cmdref \ref <name> ["(text)"]

  \addindex \ref
  Creates a reference to a named section, subsection, page or anchor.
  For HTML documentation the reference command will generate a link to 
  the section. For a sections or subsections the title of the section will be 
  used as the text of the link. For anchor the optional text between quotes
  will be used or \<name\> if no text is specified.
  For \f$\mbox{\LaTeX}\f$ documentation the reference command will 
  generate a section number for sections or the text followed by a 
  page number if \<name\> refers to an anchor.

  \sa
    Section \ref cmdpage "\\page" for an example of the \\ref command.

<hr>
\subsection cmdsection \section <section-name> (section title)
  
  \addindex \section
  Creates a section with name \<section-name\>. The title of the
  section should be specified as the second argument of the \\section 
  command.

  \warning This command only works inside related page documentation and
           \e not in other documentation blocks!

  \sa 
    Section \ref cmdpage "\\page" for an example of the 
            \ref cmdsection "\\section" command.

<hr>
\subsection cmdsubsection \subsection <subsection-name> (subsection title)

  \addindex \subsection
  Creates a subsection with name \<subsection-name\>. The title of the
  subsection should be specified as the second argument of the \\subsection
  command.

  \warning This command only works inside related page documentation and
           \e not in other documentation blocks!

  \sa
   Section \ref cmdpage "\\page" for an example of the 
           \ref cmdsubsection "\\cmdsubsection" command.

<hr>

<h2>\htmlonly <center> --- \endhtmlonly 
    Commands for displaying examples
    \htmlonly --- </center>\endhtmlonly</h2>

\subsection cmddontinclude \dontinclude <file-name>

  \addindex \dontinclude
  This command can be used to parse a source file without actually 
  verbatim including it in the documentation (as the \\include command does). 
  This is useful if you want to divide the source file into smaller pieces and
  add documentation between the pieces.
  Source files or directories can be specified using the 
  \ref cfg_example_path "EXAMPLE_PATH" 
  tag of doxygen's configuration file.

  The class and member declarations and definitions inside the code fragment
  are `remembered' during the parsing of the comment block that contained 
  the \\dontinclude command. 

  For line by line descriptions of source files, one or more lines 
  of the example can be displayed using the \\line, \\skip, \\skipline, and 
  \\until commands. An internal pointer is used for these commands. The
  \\dontinclude command sets the pointer to the first line of the example.

  \par Example:
  \verbinclude include.cpp
  Where the example file \c example_test.cpp looks as follows:
  \verbinclude example_test.cpp
  \htmlonly
  Click <a href="$(DOXYGEN_DOCDIR)/examples/include/html/example.html">here</a> 
  for the corresponding HTML documentation that is generated by doxygen.
  \endhtmlonly

  \sa sections \ref cmdline "\\line", \ref cmdskip "\\skip", 
               \ref cmdskipline "\\skipline", and \ref cmduntil "\\until".

<hr>
\subsection cmdinclude \include <file-name>

  \addindex \include
  This command can be used to include a source file as a block of code.
  The command takes the name of an include file as an argument. 
  Source files or directories can be specified using the 
  \ref cfg_example_path "EXAMPLE_PATH" 
  tag of doxygen's configuration file.

  If \<file-name\> itself is not unique for the set of example files specified
  by the 
  \ref cfg_example_path "EXAMPLE_PATH" tag, you can include part 
  of the absolute path to disambiguate it.

  Using the \\include command is equivalent to inserting the file into 
  the documentation block and surrounding it 
  with \ref cmdcode "\\code" and \ref cmdendcode "\\endcode" commands.

  The main purpose of the \\include command is to avoid code 
  duplication in case of example blocks that consist of multiple
  source and header files.

  For a line by line description of a source files use the 
  \ref cmddontinclude "\\dontinclude" command in combination with 
  the \ref cmdline "\\line", \ref cmdskip "\\skip", 
  \ref cmdskipline "\\skipline", 
  and \\until commands. 

  \sa section \ref cmdexample "\\example" and \ref cmddontinclude "\\dontinclude".

<hr>
\subsection cmdline \line ( pattern )

  \addindex \line
  This command searches line by line through the example that was last
  included using \\include or \\dontinclude until it finds a non-blank
  line. If that line contains the specified pattern, it is written 
  to the output.
  
  The internal pointer that is used to keep track of the current line in
  the example, is set to the start of the line following the non-blank
  line that was found (or to the end of the example if no such line could
  be found).

  See section \ref cmddontinclude "\\dontinclude" for an example.

<hr>
\subsection cmdskip \skip ( pattern )

  \addindex \skip
  This command searches line by line through the example that was last
  included using \\include or \\dontinclude until it finds a line that contains
  the specified pattern. 
  
  The internal pointer that is used to keep track of the current line in
  the example, is set to the start of the line that contains the specified
  pattern (or to the end of the example if the pattern could not be found). 

  See section \ref cmddontinclude "\\dontinclude" for an example.

<hr>
\subsection cmdskipline \skipline ( pattern ) 

  \addindex \skipline
  This command searches line by line through the example that was last
  included using \\include or \\dontinclude until it finds a line that contains
  the specified pattern. It then writes the line to the output.
  
  The internal pointer that is used to keep track of the current line in
  the example, is set to the start of the line following the line that is
  written (or to the end of the example if the pattern could not be found). 

  \par Note:
    The command:
    \verbatim\skipline pattern\endverbatim 
    is equivalent to:
\verbatim
\skip pattern
\line pattern\endverbatim

  See section \ref cmddontinclude "\\dontinclude" for an example.

<hr>
\subsection cmduntil \until ( pattern )

  \addindex \until
  This command writes all lines of the example that was last
  included using \\include or \\dontinclude to the output, until it finds 
  a line containing the specified pattern. The line containing the pattern
  will be written as well.
  
  The internal pointer that is used to keep track of the current line in
  the example, is set to the start of the line following last written
  line (or to the end of the example if the pattern could not be found).

  See section \ref cmddontinclude "\\dontinclude" for an example.

<hr>
\subsection cmdverbinclude \verbinclude <file-name>

  \addindex \verbinclude
  This command includes the file \<file-name\> verbatim in the documentation.
  The command is equivalent to pasting the file in the documentation and
  placing \\verbatim and \\endverbatim commands around it. 

  Files or directories that doxygen should look for can be specified using the 
  \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.

<hr>
\subsection cmdhtmlinclude \htmlinclude <file-name>

  \addindex \htmlinclude
  This command includes the file \<file-name\> as is in the HTML documentation.
  The command is equivalent to pasting the file in the documentation and
  placing \\htmlonly and \\endhtmlonly commands around it.

  Files or directories that doxygen should look for can be specified using the 
  \ref cfg_example_path "EXAMPLE_PATH" tag of doxygen's configuration file.

<hr>
<h2>\htmlonly <center> --- \endhtmlonly 
    Commands for visual enhancements
    \htmlonly --- </center>\endhtmlonly</h2>