Re: [ROOT] THtml & W3C validation

From: Rolf Dubitzky (dubitzky@pktw06.phy.tu-dresden.de)
Date: Mon Aug 05 2002 - 15:15:03 MEST 

On Monday 05 August 2002 02:03 pm, Christian Holm Christensen wrote:
> * Add the `@fn <member function>' for member function documentation.

Not even necessary. This is already enough:

--------  Foo.hh ----

/** @brief a brief description of class Foo*/
class Foo {
  public:
    /** @brief a brief description of memberFunction */
    int memberFunction( int arg );
};

.....  Foo.cc

#include "foo.hh"

/** @class Foo
 *  a detailed description of Foo
 */

/**
 * a detailed description of memberFunction
 * @param arg a dymm
 * @return nothing
 * <UL>
 * <LI> can be
 * <LI> long
 * <UI>
 */
int
Foo::memberFunction( int arg )
{
    return 0;
}

-----------

> * Edit your configuration, or use the GNOME GUI `doxywizard' to make
>   your configuration.

you can also use 'doxygen -g' to create an example.

Replacing THtml with doxygen would improve documentation instantly in 
noumerous ways. Not mentioning the availability of more features.

Cheers,
Rolf

***************************************************************
 Rolf Dubitzky  
 e-mail: Rolf.Dubitzky@Physik.TU-Dresden.de
 s-mail see http://hep.phy.tu-dresden.de/~dubitzky/
***************************************************************

This archive was generated by hypermail 2b29 : Sat Jan 04 2003 - 23:51:03 MET