Hi,
I use the \param together with "::" to document the use of global variables
within a function. This works fine, but I get a warning about "@param is not
found in the argument list...". Can I turn off the warning for the case the
parameter is not in the functions parameter list, but is a global variable?
Example:
/**
* Lookup table for CRC calculation.
*/
static uint8_t crc_table[] = {
...
};
/**
* Calculates CRC.
*
* \param[in] data Points to data for which to calculate the CRC.
* \param[in] len Number of bytes.
* \param[in] ::crc_table
*/
uint16_t CalcCRC(uint8_t *data, size_t len)
{
...
}
Doxygen does exactly what I want. The global variable crc_table is listed as
input parameter within the documentation for the CalcCRC() function and it also
gives a link to the global variable itself.
That's pretty fine. The only unpleasant fact is the warning itself. Is there a
way to prevent this warning without turning it off generally?
BTW: I use doxygen 1.7.4.
Thanks & Best regards,
Franz Hollerer
------------------------------------------------------------------------------
Everyone hates slow websites. So do we.
Make your web apps faster with AppDynamics
Download AppDynamics Lite for free today:
http://p.sf.net/sfu/appdyn_d2d_feb
_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
