Merge pull request #89 from albert-github/feature/docu_update

  \addindex \\category

  For Objective-C only: Indicates that a comment block contains documentation

  for a class category with name \<name\>. The arguments are

  equal to the \\class command.

  equal to the \ref cmdclass "\\class" command.

  \sa section \ref cmdclass "\\class".

<hr>

\section cmdrelated \\related <name>

  \addindex related

  \addindex \\related

  Equivalent to \ref cmdrelates "\\relates"

<hr>

<hr>

\section cmdrelatedalso \\relatedalso <name>

  \addindex relatedalso

  \addindex \\relatedalso

  Equivalent to \ref cmdrelatesalso "\\relatesalso"

<hr>

 *  Rest of the comment block continues.

 */

\endverbatim

  Note that the \\parblock command may also appear directly after

  \\param's first argument.

  Note that the \c \\parblock command may also appear directly after

  \ref cmdparam "\\param"'s first argument.

<hr>

\section cmdendparblock \\endparblock

  \addindex \\endparblock

  This ends a block of paragraphs started with \\ref cmdparblock "\\parblock".

  This ends a block of paragraphs started with \ref cmdparblock "\\parblock".

<hr>

\section cmdtparam \\tparam <template-parameter-name> { description }

  may be selected by including a parenthesized list of argument types after

  the method name.

  Synonymous to \\see.

  Synonymous to \ref cmdsee "\\see".

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

      to objects.

\section cmdsince \\since { text }

  \addindex \\since

  This tag can be used to specify since when (version or time) an

  This command can be used to specify since when (version or time) an

  entity is available. The paragraph that follows \c \\since does not have any

  special internal structure. All visual enhancement commands may be

  used inside the paragraph. The \c \\since description ends when a blank

  Synonymous \ref cmdexception "\\exception".

  \par Note:

  the tag \c \\throws is a synonym for this tag.

  the command \ref cmdthrows "\\throws" is a synonym for this command.

  \sa section \ref cmdexception "\\exception"

  \ref cmddontinclude "\\dontinclude" command in combination with

  the \ref cmdline "\\line", \ref cmdskip "\\skip",

  \ref cmdskipline "\\skipline",

  and \\until commands.

  and \ref cmduntil "\\until" commands.

  Alternatively, the \ref cmdsnippet "\\snippet" command can be used to

  include only a fragment of a source file. For this to work the

<hr>

\section cmdcopybrief \\copybrief <link-object>

  \addindex \\copybrief

Works in a similar way as \ref cmdcopydoc "\\copydoc" but will

only copy the brief description, not the detailed documentation.

<hr>

\section cmdcopydetails \\copydetails <link-object>

  \addindex \\copydetails

Works in a similar way as \ref cmdcopydoc "\\copydoc" but will

only copy the detailed documentation, not the brief description.

  Doxygen will pass the text on to dot and include the resulting

  image (and image map) into the output.

  The nodes of a graph can be made clickable by using the URL attribute.

  By using the command \\ref inside the URL value you can conveniently

  By using the command \ref cmdref "\\ref" inside the URL value you can conveniently

  link to an item inside doxygen. Here is an example:

\code

/*! class B */

class Sender

{

  public:

    /** Acknowledgement from server */

    /** Acknowledgment from server */

    void Ack(bool ok);

};

/** Receiver class. Can be used to receive and execute commands.

 *  After execution of a command, the receiver will send an acknowledgement

 *  After execution of a command, the receiver will send an acknowledgment

 *  \msc

 *    Receiver,Sender;

 *    Receiver<-Sender [label="Command()", URL="\ref Command()"];

\section cmdamp \\\&

  \addindex \\\&

  This command writes the \c \& character to output.

  This command writes the \c \& character to the output.

  This character has to be escaped because it has a special meaning in HTML.

<hr>

files as one big DOM tree would not fit into memory.

See <a href="https://github.com/michaeljones/breathe">the Breathe project</a> for

a example that uses doxygen XML output from Python to bridge it with the 

an example that uses doxygen XML output from Python to bridge it with the 

<a href="http://sphinx.pocoo.org/">Sphinx</a> document generator.

set \ref cfg_optimize_for_fortran "OPTIMIZE_FOR_FORTRAN" to \c YES.

For Fortran "!>" or "!<" starts a comment and "!!" or "!>" can be used to 

continuate a one line comment into a multi-line comment.

continue an one line comment into a multi-line comment.

Here is an example of a documented Fortran subroutine:

\verbatim

    Type(SpMtx), intent(out) :: Restrict !< Our restriction matrix

\endverbatim

As a alternative you can also use comments in fixed format code:

As an alternative you can also use comments in fixed format code:

\verbatim

C> Function comment

\verbatim TCL_SUBST = class itcl:class body itcl:body \endverbatim

-->

Following is a example using doxygen style comments:

Following is an example using doxygen style comments:

\include tclexample.tcl

 \htmlonly

/*! \page doxygen_usage Doxygen usage

Doxygen is a command line based utility.  Calling \c doxygen with the

\c --help option at the command line will give you a brief description of the 

`--help` option at the command line will give you a brief description of the 

usage of the program.

All options consist of a leading character <tt>-</tt>, 

<ul>

<li><tt>\<A HREF="..."\></tt> Starts a hyperlink 

                       (if supported by the output format). 

<li><tt>\<A NAME="..."\></tt> Starts an named anchor 

<li><tt>\<A NAME="..."\></tt> Starts a named anchor 

                       (if supported by the output format).

<li><tt>\</A\></tt>    Ends a link or anchor 

<li><tt>\<B\></tt>     Starts a piece of text displayed in a bold font.

<li><tt>\&?uml;</tt>   where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y}, 

       writes a character with a diaeresis accent (like ä).

<li><tt>\&?acute;</tt> where ? is one of {A,E,I,O,U,Y,a,e,i,o,u,y},

       writes a character with a acute accent (like á). 

       writes a character with an acute accent (like á). 

<li><tt>\&?grave;</tt> where ? is one of {A,E,I,O,U,a,e,i,o,u,y},

       writes a character with a grave accent (like à).

<li><tt>\&?circ;</tt>  where ? is one of {A,E,I,O,U,a,e,i,o,u,y},