What's the best way to doc inputs to functions that are not function
parameters?
There is no @in command for describing these interfaces.
i.e. a function has params, but as input uses a private class member or
other classes as an input.
I am currently used to documenting my code this way:
/**
* function description...
* in: params, other member inputs m_* that are not params, could be
objects or data,
* in this case it's a class member m_nMultiplier, but could be
another object.
* out: (similar to @return), in this case the function return value.
* pre: object state expectation that this function expects, in this
case:
* pre: m_nMultiplier is assumed to be initialized to a valid
state/range.
* post: an object/program state condition that exist after function is
called). In this case
* none.
*/
int MyClass::foo( int param1)
{
return this->m_nMultiplier * param1;
}
Using dxoygen I can convert everything but inputs, what do people use in
this case?
/**
* function description...
* in: (params, other member inputs m_* that are not params, could be
objects or data)
* @return: (similar to post, but usually uses for class members)
* @pre (object state expectation)
* @post (more of an object state condition).
*/
|
