[Doxygen-users] Question on function-parameters documentation..

[Jaap S. <s98...@ho...>]

Hello,

I'm new on the list and I've only been working with Doxygen for four days 
now. I've searched the documentation and the online mail-archives but 
coulnd't find any help on this one...

What is the difference between:

/*!
     \brief Some function
     \param x Argument X
*/
void Function( x ) {}

and

/*!
     \brief Some function
*/
void Function(
               x //!< Argument X
             )
{}

Basically, what is the difference between documenting the parameter in the 
source-comment, or directly after the declaration of the argument?
I'd rather use the latter, cause it saves me typing the argument-name twice. 
However, when I use it all sorts of things dissappear in my generated 
documentation.

With the functions that use the \param method I get the brief comment below 
it with a 'more...' behind it. With the other method I don't get that. And 
also the detailed information just seems to be ignored with the latter 
method. Very confusing.

I could provide you with a short example should that be neccesary.

Thanks for your help,

Jaap Suter


_________________________________________________________________
Chat on line met vrienden en probeer MSN Messenger uit: 
http://messenger.msn.nl