Aquileo | invalid warning when hierarchically documenting class method

2003-04-20T01:20:41Z

Hi,

I am receiving an invalid warning from doc++ when I
am trying to document the methods of a class
hierarchically. Here is an example:
/**@name protein.C */
//@{

// start methods and functions

/**@name constructor, destructor, and node creation */

//@{
///constructor
Protein::Protein(int _index)
{
// the constructor code
}

///destructor
Protein::~Protein()
{
// some code here.
}

//@}

/** setup related */

//@{
///setup code.
void Protein::doSetup()
{
//other code here
}
//@}

//@}

And then run doc++ with the parameter file containing:
showFilenames true
verboseOperation true
HTMLSyntax true
useTablesWithBorders true
outputDir html
sortEntries true

I get such warnings:
Warning: no parent `protein.C ::constructor, destructor,
and node creation ::Protein' for ` protein.C ::constructor,
destructor, and node creation ::Protein::Protein(int
_index)' found

if I add a line just before the constructor
having /**@name protein*/, the warning disappears, but
then the documentation does not contain anything for
the constructor method (it instead contains a link with
title protein, and then all following methods in that
scope (such as the destructor) appear after clicking that
link.

I think the reason is the use of "::" within doc++ itself for
denoting structure (as can be seen from the warning)
and when I use "::" in my code for my class methods, it
confuses doc++ and makes it look for a protein parent,
which it cannot find, and thus gives a warning.

Although the warning appears, the resulting
documentation is as I want, but the warnings are
nevertheless annoying.

Aquileo | Recent changes to 18: invalid warning when hierarchically documenting class method

Aquileo | invalid warning when hierarchically documenting class method