Re: [Doxygen-users] Function parameter type

[Dean P. <po...@ds...>]

>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 u=
se.
>

We tend to do this in our function documentation (Note: Javadoc syntax):

/**
 * A brief description of the function
 *
 * @param a [in] An input parameter
 * @param b [out] An out parameter
 * @param c [inout] An in-out parameter
 *
 * @return ...
 */

Which formats nicely in doxygen.

Cheers.



-- =

Dean Povey,         | e-m: po...@ds... | JCSI: Java Crypto Toolkit =

Research Scientist  | ph:  +61 7 3864 5120   | uPKI: C PKI toolkit for em=
bedded
Security Unit, DSTC | fax: +61 7 3864 1282   |       systems
Brisbane, Australia | www: security.dstc.com | =