[LORENE] Correction of a bug in Doc++

Eric Gourgoulhon Eric.Gourgoulhon at obspm.fr
Thu Nov 6 16:20:54 CET 2003

Dear All,

Thanks to Reinhard, we have found a way to circumvent an annoying
bug in Doc++, which altered slightly Lorene's html documentation.
Indeed Doc++ does not distinguish overloaded methods
when the parameters of these methods are declared
'const'. Considerer the following example:

class A ;
class B ;

/** Class C
class C {

/// Constructor from A
C(const A&) ;

/// Constructor from B
C(const B&) ;

} ;

DOC++ gives the warning message
"Warning: ` C::C(const B&)' already have documentation, merging"
and produces the following incorrect output:

C(const B&)
Constructor from BConstructor from A

This bug is present in the current version (3.4.10) of Doc++,
as well as in the two previous ones (3.4.8 and 3.4.9),
but it did not exist in older versions (e.g. 3.2).
This bug has been already pointed out in March 2001 (see
http://groups.yahoo.com/group/docpp/message/1028 )
but no fixing has been performed yet.

The way to circumvent the bug is to give a name
to the arguments in the prototypes, i.e. to declare

/// Constructor from A
C(const A& a) ;

/// Constructor from B
C(const B& b) ;

The header files of Lorene have been modified
accordingly and there is no longer any problem
in Doc++ documentation. So if you wish to have
a nice local documentation, please launch the
lorene_up command now (the online documentation
in http://www.lorene.obspm.fr/ is already fixed).

Best wishes,


Eric Gourgoulhon
Laboratoire de l'Univers et de ses THeories (LUTH)
UMR 8102 du CNRS / Observatoire de Paris, F-92195 Meudon Cedex, France
tel: +33 (secretariat : +33
e-mail: Eric.Gourgoulhon at obspm.fr    WWW: http://www.luth.obspm.fr/

More information about the Lorene.list mailing list