[Doxygen-users] Function parameter type

[Stephane R. <rou...@ca...>]

Hello,

For the function parameters, we can use \param and \retval.
Is it possible to have a flag to say that the parameter is "in-out"
The name inout is perhaps not the best one, but I have no idea what to use.

If you think it is interessant to have, can somebody integrate it ( I don't
have the source and never read them )?

BTW, I'm using OpenCASCADE ( www.opencascade.org ), and they have a CDL
language to generate the C++ header and implementation files.
They are specifying interessant attribute for the parameters (in , out,
inout, mutable, immutable , etc ... ).
What a pity that these informations are not used in C++ :-((

Thanks,

Stephane

ex :

/** \fn void SetValue(const int anInteger);
 * \param anInteger const int : the value to set
*/
void SetValue(const int anInteger)
{    myValue = anInteger; };

/** \fn void Value(int& anInteger) const
* \retval anInteger int& : the value
*/
void Value(int& anInteger) const
{anInteger =  myValue;};

/** \fn void Multiply(int& anInteger,const int aMultiplicator)
 * \inout anInteger the value to muliply and returns the multiplied value
* \param aMultiplicator
*/
void Multiply(int& anInteger,const int aMultiplicator)
{
    anInteger = anInteger*aMultiplicator;
};
=================================================
Stephane ROUTELOUS
C A D / C A M  -  C o n c e p t   G m b H
Albert-Einstein-Straße 14 . D-12489 Berlin
rou...@ca...    http://www.cad-cam-concept.de
phone  : +49 (0)30 63.92.65.38      fax : +49 (0)30 63.92.63.19
=================================================
"It is ridiculous to claim that video games influence children.
For instance, if PacMan affected kids born in the eighties, we
should by now have a bunch of teenagers who run around in darkened
rooms eating pills while listening to monotonous electronic music."