Release-1.2.0

1 files changed, 121 insertions, 27 deletions

diff --git a/doc/commands.doc b/doc/commands.doc
index 5617c5b..7791c8b 100644
--- a/doc/commands.doc
+++ b/doc/commands.doc
@@ -61,6 +61,7 @@ documentation:
 <li> \refitem cmddeprecated \deprecated
 <li> \refitem cmddontinclude \dontinclude
 <li> \refitem cmde \e
+<li> \refitem cmdem \em
 <li> \refitem cmdendcode \endcode
 <li> \refitem cmdendhtmlonly \endhtmlonly
 <li> \refitem cmdendif \endif
@@ -84,13 +85,16 @@ documentation:
 <li> \refitem cmdinternal \internal
 <li> \refitem cmdinvariant \invariant
 <li> \refitem cmdlatexonly \latexonly
+<li> \refitem cmdli \li
 <li> \refitem cmdline \line
 <li> \refitem cmdlink \link
 <li> \refitem cmdmainpage \mainpage
 <li> \refitem cmdname \name
 <li> \refitem cmdnamespace \namespace
 <li> \refitem cmdnosubgrouping \nosubgrouping
+<li> \refitem cmdnote \note
 <li> \refitem cmdoverload \overload
+<li> \refitem cmdp \p
 <li> \refitem cmdpage \page
 <li> \refitem cmdpar \par
 <li> \refitem cmdparam \param
@@ -165,17 +169,6 @@ Doxygen. Unrecognized commands are treated as normal text.
   \endhtmlonly
 
 <hr>
-\subsection cmdcode \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 
-  links to the documentation. 
-
-  \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim"  
-
-<hr>
 \subsection cmddef \def <name>
 
   \addindex \def
@@ -185,7 +178,7 @@ Doxygen. Unrecognized commands are treated as normal text.
   \par Example:
   \verbinclude define.h  
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/index.html">here</a> 
+  Click <a href="$(DOXYGEN_DOCDIR)/examples/define/html/define.h.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 
@@ -204,13 +197,6 @@ Doxygen. Unrecognized commands are treated as normal text.
   \sa section \ref cmdingroup "\\ingroup"
 
 <hr>
-\subsection cmdendcode \endcode
-
-  \addindex \endcode
-  Ends a block of code.
-  \sa section \ref cmdcode "\\code"
- 
-<hr>
 
 \subsection cmdenum \enum <name>
 
@@ -229,7 +215,7 @@ Doxygen. Unrecognized commands are treated as normal text.
   \par Example:
   \verbinclude enum.h  
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/index.html">here</a> 
+  Click <a href="$(DOXYGEN_DOCDIR)/examples/enum/html/class_test.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 
@@ -260,7 +246,7 @@ Doxygen. Unrecognized commands are treated as normal text.
   Where the example file \c example_test.cpp looks as follows:
   \verbinclude example_test.cpp
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/index.html">here</a> 
+  Click <a href="$(DOXYGEN_DOCDIR)/examples/example/html/examples.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 
@@ -283,7 +269,7 @@ Doxygen. Unrecognized commands are treated as normal text.
   \par Example:
   \verbinclude file.h  
   \htmlonly
-  Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/index.html">here</a> 
+  Click <a href="$(DOXYGEN_DOCDIR)/examples/file/html/file.h.html">here</a> 
   for the corresponding HTML documentation that is generated by Doxygen.
   \endhtmlonly
 
@@ -412,6 +398,8 @@ Public/Protected/Private/... section.
   \par Note 1:
     You are responsible that there is indeed an
     earlier documented member that is overloaded by this one.
+    To prevent that document reorders the documentation you should set
+    \ref cfg_sort_member_docs "SORT_MEMBER_DOCS" to NO in this case.
   \par Note 2:
     The \\overload command does not work inside a one-line comment.
   \par Example:
@@ -685,6 +673,20 @@ Public/Protected/Private/... section.
   sectioning command is encountered.
 
 <hr>
+\subsection cmdnote \note { text }
+
+  \addindex \note
+  Starts a paragraph where a note can 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 \\note commands will be joined into a single paragraph.
+  Each note description will start on a new line.
+  Alternatively, one \\note command may mention 
+  several notes. The \\note command ends when a blank line or some other 
+  sectioning command is encountered. See section \ref cmdpar "\\par" 
+  for an example.
+
+<hr>
 \subsection cmdpar \par [(paragraph title)] { paragraph }
 
   \addindex \par
@@ -797,10 +799,11 @@ Public/Protected/Private/... section.
   \addindex \sa
   Starts a paragraph where one or more cross-references to classes, 
   functions, methods, variables, files or URL may be specified.
-  The separators \c :: and \c # may be used to separate a class from the
-  name of its members. One of several overloaded methods or constructors 
+  Two names joines 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. 
+  the method name. 
 
   Synonymous to \\see.
 
@@ -1112,11 +1115,11 @@ Public/Protected/Private/... section.
 
   \par Example:
   \verbatim
-  ... the \a x and \y coordinates are used to ...
+  ... the \a x and \a y coordinates are used to ...
   \endverbatim 
   This will result in the following text:<br><br>
   ... the \a x and \a y coordinates are used to ...
- 
+
 <hr>
 \subsection cmdarg \arg { item-description }
   
@@ -1147,6 +1150,9 @@ Public/Protected/Private/... section.
   \par Note:
   For nested lists, HTML commands should be used.
 
+  Equivalent to \ref cmdli "\\cmdli"
+
+
 <hr>
 \subsection cmdb \b <word>
 
@@ -1170,6 +1176,19 @@ Public/Protected/Private/... section.
   will result in the following text:<br><br>
      ... This function returns \c void and not \c int ...
 
+  Equivalent to \ref cmdp "\\cmdp"
+
+<hr>
+\subsection cmdcode \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 
+  links to the documentation. 
+
+  \sa section \ref cmdendcode "\\endcode", section \ref cmdverbatim "\\verbatim"  
+
 <hr>
 \subsection cmde \e <word>
 
@@ -1185,6 +1204,32 @@ Public/Protected/Private/... section.
   will result in the following text:<br><br>
   ... this is a \e really good example ...
 
+  Equvalent to \ref cmdem "\\em"
+
+<hr>
+\subsection cmdem \em <word>
+
+  \addindex \e 
+  Displays the argument \<word\> in italics.
+  Use this command to emphasize words.
+
+  \par Example:
+  Typing:
+  \verbatim
+  ... this is a \em really good example ... 
+  \endverbatim
+  will result in the following text:<br><br>
+  ... this is a \em really good example ...
+
+  Equivalent to \ref cmde "\\e"
+
+<hr>
+\subsection cmdendcode \endcode
+
+  \addindex \endcode
+  Ends a block of code.
+  \sa section \ref cmdcode "\\code"
+ 
 <hr>
 \subsection cmdendhtmlonly \endhtmlonly
 
@@ -1322,6 +1367,55 @@ Public/Protected/Private/... section.
   and section \ref cmdhtmlonly "\\htmlonly".
 
 <hr>
+\subsection cmdli \li { item-description }
+  
+  \addindex \li
+  This command has one argument that continues until the first
+  blank line or until another \\li is encountered.
+  The command can be used to generate a simple, not nested list of
+  arguments. 
+  Each argument should start with a \\li command.
+  
+  \par Example:
+  Typing:
+  \verbatim
+  \li \c AlignLeft left alignment.
+  \li \c AlignCenter center alignment.
+  \li \c AlignRight right alignment
+  
+  No other types of alignment are supported.
+  \endverbatim
+  will result in the following text:<br><br>
+  <ul>
+  <li> \c AlignLeft left alignment.
+  <li> \c AlignCenter center alignment.
+  <li> \c AlignRight right alignment
+  </ul><br>
+  No other types of alignment are supported.
+
+  \par Note:
+  For nested lists, HTML commands should be used.
+
+  Equivalent to \ref cmdarg "\\cmdarg"
+
+<hr>
+\subsection cmdp \p <word>
+ 
+  \addindex \p
+  Displays the parameter \<word\> using a typewriter font.
+  You can use this command to refer to member function parameters in 
+  the running text.
+
+  \par Example:
+  \verbatim
+  ... the \p x and \p y coordinates are used to ...
+  \endverbatim 
+  This will result in the following text:<br><br>
+  ... the \p x and \p y coordinates are used to ...
+
+  Equivalent to \ref cmdc "\\cmdc"
+ 
+<hr>
 \subsection cmdverbatim \verbatim
 
   \addindex \verbatim