Release-1.7.2

1 files changed, 105 insertions, 23 deletions

diff --git a/doc/commands.doc b/doc/commands.doc
index 69f22e7..42e76e0 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -43,6 +43,7 @@ documentation:
 \refitem cmdarg \\arg
 \refitem cmdattention \\attention
 \refitem cmdauthor \\author
+\refitem cmdauthors \\authors
 \refitem cmdb \\b
 \refitem cmdbrief \\brief
 \refitem cmdbug \\bug
@@ -80,6 +81,7 @@ documentation:
 \refitem cmdendlink \\endlink
 \refitem cmdendmanonly \\endmanonly
 \refitem cmdendmsc \\endmsc
+\refitem cmdendrtfonly \\endrtfonly
 \refitem cmdendverbatim \\endverbatim
 \refitem cmdendxmlonly \\endxmlonly
 \refitem cmdenum \\enum
@@ -138,14 +140,20 @@ documentation:
 \refitem cmdpublic \\public
 \refitem cmdpublic \\publicsection
 \refitem cmdref \\ref
+\refitem cmdrelated \\related
 \refitem cmdrelates \\relates
+\refitem cmdrelatedalso \\relatedalso
 \refitem cmdrelatesalso \\relatesalso
+\refitem cmdremark \\remark
 \refitem cmdremarks \\remarks
 \refitem cmdreturn \\return
+\refitem cmdreturns \\returns
 \refitem cmdretval \\retval
+\refitem cmdrtfonly \\rtfonly
 \refitem cmdsa \\sa
 \refitem cmdsection \\section
 \refitem cmdsee \\see
+\refitem cmdshort \\short
 \refitem cmdshowinitializer \\showinitializer
 \refitem cmdsince \\since
 \refitem cmdskip \\skip
@@ -156,6 +164,7 @@ documentation:
 \refitem cmdsubsubsection \\subsubsection
 \refitem cmdtest \\test
 \refitem cmdthrow \\throw
+\refitem cmdthrows \\throws
 \refitem cmdtodo \\todo
 \refitem cmdtparam \\tparam
 \refitem cmdtypedef \\typedef
@@ -829,6 +838,12 @@ Structural indicators
   \endhtmlonly
 
 <hr>
+\section cmdrelated \\related <name>
+
+  \addindex related
+  Equivalent to \ref cmdrelates "\\relates"
+
+<hr>
 \section cmdrelatesalso \\relatesalso <name>
 
   \addindex \\relatesalso
@@ -840,6 +855,12 @@ Structural indicators
   class. It only works for functions.  
 
 <hr>
+\section cmdrelatedalso \\relatedalso <name>
+
+  \addindex relatedalso
+  Equivalent to \ref cmdrelatesalso "\\relatesalso"
+
+<hr>
 \section cmdshowinitializer \\showinitializer
 
   \addindex \\showinitializer
@@ -940,6 +961,11 @@ Section indicators
   Click <a href="$(DOXYGEN_DOCDIR)/examples/author/html/class_windows_n_t.html">here</a> 
   for the corresponding HTML documentation that is generated by doxygen.
   \endhtmlonly
+<hr>
+\section cmdauthors \\authors { list of authors }
+
+  \addindex \\authors
+  Equivalent to \ref cmdauthor "\\author".
 
 <hr>
 \section cmdbrief \\brief {brief description}
@@ -956,7 +982,7 @@ Section indicators
   \ref cmdauthor "\\author" for an example. 
 
   Synonymous to \\short.
- 
+
 <hr>
 \section cmdbug \\bug { bug description }
 
@@ -1337,9 +1363,9 @@ void memcpy(void *dest, const void *src, size_t n);
   sectioning command is encountered.
   
 <hr>
-\section cmdremarks \\remarks { remark text }
+\section cmdremark \\remark { remark text }
 
-  \addindex \\remarks
+  \addindex \\remark
   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
@@ -1351,6 +1377,12 @@ void memcpy(void *dest, const void *src, size_t n);
   sectioning command is encountered. 
 
 <hr>
+\section cmdremarks \\remarks { remark text }
+
+  \addindex \\remarks
+  Equivalent to \ref cmdremark "\\remark".
+
+<hr>
 \section cmdreturn \\return { description of the return value }
 
   \addindex \\return
@@ -1361,12 +1393,18 @@ void memcpy(void *dest, const void *src, size_t n);
   The \\return description ends when a blank line or some other 
   sectioning command is encountered. See section \ref cmdfn "\\fn" for an 
   example.
+
+<hr>
+\section cmdreturns \\returns { description of the return value }
+
+  \addindex \\returns
+  Equivalent to \ref cmdreturn "\\return".
   
 <hr>
 \section cmdretval \\retval <return value> { description }
 
   \addindex \\retval
-  Starts a return value description for a function with name 
+  Starts a description for a function's return value 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 
@@ -1400,6 +1438,12 @@ void memcpy(void *dest, const void *src, size_t n);
   Equivalent to \ref cmdsa "\\sa". Introduced for compatibility with Javadoc.
 
 <hr>
+\section cmdshort \\short {short description}
+
+  \addindex \\short
+  Equivalent to \\ref cmdbrief "\\brief".
+ 
+<hr>
 \section cmdsince \\since { text }
 
   \addindex \\since
@@ -1429,6 +1473,12 @@ void memcpy(void *dest, const void *src, size_t n);
   the tag \\throws is a synonym for this tag.
 
 <hr>
+\section cmdthrows \\throws <exception-object> { exception description }
+
+  \addindex \\throws
+  Equivalent to \ref cmdthrows "\\throws".
+
+<hr>
 \section cmdtodo \\todo { paragraph describing what is to be done }
 
   \addindex \\todo
@@ -2202,12 +2252,21 @@ class Receiver
   \sa section \ref cmdmanonly "\\manonly".
 
 <hr>
+\section cmdendrtfonly \\endrtfonly
+
+  \addindex \\endrtfonly
+  Ends a block of text that was started with a \\rtfonly command.
+
+  \sa section \ref cmdrtfonly "\\rtfonly".
+
+
+<hr>
 \section cmdendverbatim \\endverbatim
 
   \addindex \\endverbatim
   Ends a block of text that was started with a \\verbatim command.
   
-  \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim".
+  \sa section \ref cmdverbatim "\\verbatim".
 
 <hr>
 \section cmdendxmlonly \\endxmlonly
@@ -2262,7 +2321,7 @@ class Receiver
   \addindex \\htmlonly
   Starts a block of text that will be verbatim included in the
   generated HTML documentation only. The block ends with a
-  endhtmlonly command.
+  \ref cmdhtmlonly "\\endhtmlonly" command.
 
   This command can be used to include HTML code that is too complex
   for doxygen (i.e. applets, java-scripts, and HTML tags that
@@ -2273,8 +2332,9 @@ class Receiver
     environment variables (like \$(HOME) ) are resolved inside a 
     HTML-only block.
 
-  \sa section \ref cmdmanonly "\\manonly" and section 
-              \ref cmdlatexonly "\\latexonly".
+  \sa section \ref cmdmanonly "\\manonly", section 
+              \ref cmdlatexonly "\\latexonly", and section
+              \ref cmdrtfonly "\\rtfonly".
 
 <hr>
 \section cmdimage \\image <format> <file> ["caption"] [<sizeindication>=<size>]
@@ -2337,7 +2397,7 @@ class Receiver
   \addindex \\latexonly
   Starts a block of text that will be verbatim included in the
   generated \f$\mbox{\LaTeX}\f$ documentation only. The block ends with a
-  endlatexonly command.
+  \ref cmdendlatexonly "\\endlatexonly" command.
 
   This command can be used to include \f$\mbox{\LaTeX}\f$ code that is too 
   complex for doxygen (i.e. images, formulas, special characters). You can 
@@ -2348,8 +2408,9 @@ class Receiver
     environment variables (like \$(HOME) ) are resolved inside a 
     \f$\mbox{\LaTeX}\f$-only block.
 
-  \sa section \ref cmdlatexonly "\\latexonly" 
-  and section \ref cmdhtmlonly "\\htmlonly".
+  \sa section \ref cmdrtfonly "\\rtfonly",
+      section \ref cmdmanonly "\\manonly", and
+      section \ref cmdhtmlonly "\\htmlonly".
 
 <hr>
 \section cmdmanonly \\manonly
@@ -2357,15 +2418,16 @@ class Receiver
   \addindex \\manonly
   Starts a block of text that will be verbatim included in the
   generated MAN documentation only. The block ends with a
-  endmanonly command.
+  \ref cmdendmanonly "\\endmanonly" command.
 
   This command can be used to include groff code directly into
   MAN pages. You can use the \\htmlonly and \\latexonly and 
   \\endhtmlonly and \\endlatexonly pairs to provide proper 
   HTML and \f$\mbox{\LaTeX}\f$ alternatives.
 
-  \sa section \ref cmdhtmlonly "\\htmlonly" and section 
-              \ref cmdlatexonly "\\latexonly".
+  \sa section \ref cmdhtmlonly "\\htmlonly", 
+      section \ref cmdrtfonly "\\rtfonly", and
+      section \ref cmdlatexonly "\\latexonly".
 
 <hr>
 \section cmdli \\li { item-description }
@@ -2424,18 +2486,38 @@ class Receiver
   Equivalent to \ref cmdc "\\c"
  
 <hr>
+\section cmdrtfonly \\rtfonly
+
+  \addindex \\rtfonly
+  Starts a block of text that will be verbatim included in the
+  generated RTF documentation only. The block ends with a
+  \ref cmdendrtfonly "\\endrtfonly" command.
+
+  This command can be used to include RTF code that is too complex
+  for doxygen. 
+
+  \b Note:
+    environment variables (like \$(HOME) ) are resolved inside a 
+    RTF-only block.
+
+  \sa section \ref cmdmanonly "\\manonly", section 
+              \ref cmdlatexonly "\\latexonly", and section
+              \ref cmdhtmlonly "\\htmlonly".
+
+<hr>
 \section cmdverbatim \\verbatim
 
   \addindex \\verbatim
-  Starts a block of text that will be verbatim included in both the
-  HTML and the 
-  \f$\mbox{\LaTeX}\f$ documentation. The block should end with a 
-  \\endverbatim block. All commands are disabled in a verbatim block.
+  Starts a block of text that will be verbatim included in 
+  the documentation. The block should end with a 
+  \ref cmdendverbatim "\\endverbatim" block. 
+  All commands are disabled in a verbatim block.
 
   \warning Make sure you include a \\endverbatim command for each 
   \\verbatim command or the parser will get confused!
 
-  \sa section \ref cmdcode "\\code", and section \ref cmdverbinclude "\\verbinclude".
+  \sa section \ref cmdcode "\\code", and 
+      section \ref cmdverbinclude "\\verbinclude".
 
 <hr>
 \section cmdxmlonly \\xmlonly
@@ -2454,16 +2536,16 @@ class Receiver
 \section cmdbackslash \\\\
 
   \addindex \\\\
-  This command writes a backslash character (\\) to the HTML and 
-  \f$\mbox{\LaTeX}\f$ output. The backslash has to be escaped in some 
+  This command writes a backslash character (\\) to the 
+  output. The backslash has to be escaped in some 
   cases because doxygen uses it to detect commands.
 
 <hr>
 \section cmdat \\\@
 
   \addindex \\\@
-  This command writes an at-sign (\@) to the HTML and 
-  \f$\mbox{\LaTeX}\f$ output. The at-sign has to be escaped in some cases 
+  This command writes an at-sign (\@) to the output. 
+  The at-sign has to be escaped in some cases 
   because doxygen uses it to detect JavaDoc commands.
 
 <hr>