[Doxygen-users] C++ vs. Qt comment style

[Sam M. <sa...@ia...>]

Hello,

I was documenting a class this afternoon and ran into the following 
situation.  Using the C++ comment style produces a warning whereas the 
Qt commenting style does not product such a warning.  Am I doing 
something incorrectly or is this a bug in doxygen?  I have tried both 
doxygen 1.4.6 built from source and the Mac OS X binary, they produce 
the same warning.

This is the warning:

/afs/scl.ameslab.gov/user/samm/fountain/source/nodes/NodeMessage.h:101: 
Warning: The following parameters of NodeRequest::buildLostParent(const 
NodeID &src, const NodeID &dest, const NodeID &parentID, const char 
*message) are not documented:
   parameter src
   parameter dest

Here is the C++ style comments for the method:

//! \brief Create a lostParent request message
//! \param[in] src The origin of this message
//! \param[in] dest The destination of this message
//! \param[in] parentID The NodeID of the lost parent node
//! \param[in] message A descriptive message about why the parent node 
was lost
//! \retval NodeRequestPtr A pointer to the request message
static NodeRequestPtr buildLostParent(const NodeID& src, const NodeID& 
dest, const NodeID& parentID, const char* message);

And here is The Qt style comments:

/*!
  \brief Create a lostParent request message
  \param[in] src The origin of this message
  \param[in] dest The destination of this message
  \param[in] parentID The NodeID of the lost parent node
  \param[in] message A descriptive message about why the parent node was 
lost
  \retval NodeRequestPtr A pointer to the request message
  */
static NodeRequestPtr buildLostParent(const NodeID& src, const NodeID& 
dest, const NodeID& parentID, const char* message);


Sam Miller
Graduate Research Assistant
Department of Electrical and Computer Engineering
Iowa State University
312 Wilhelm Hall
Ames Laboratory (515) 294-2148
Ames, IA - 50011 sa...@sc...
http://www.scl.ameslab.gov/~samm/