Doxygen - <X>:1: warning: return type of member X is not documented
Posted
by
Matt Clarkson
on Stack Overflow
See other posts from Stack Overflow
or by Matt Clarkson
Published on 2011-02-08T15:23:28Z
Indexed on
2011/02/08
15:25 UTC
Read the original article
Hit count: 298
doxygen
/*! \var GLOBAL_VAR
* \brief This is my global initialisation array for MY_STRUCT
*/
MY_STRUCT GLOBAL_VAR = {
1,
3,
2,
1,
};
I get the following error:
<GLOBAL_VAR>:1: warning: return type of member GLOBAL_VAR is not documented
But this shouldn't have any return type?!
If I do either of the following the warning goes away:
/*! \var GLOBAL_VAR
* \brief This is my global initialisation array for MY_STRUCT
* \returns
*/
MY_STRUCT GLOBAL_VAR = {
1,
3,
2,
1,
};
Or:
/*! \var GLOBAL_VAR
* \brief This is my global initialisation array for MY_STRUCT
*/
MY_STRUCT GLOBAL_VAR = 3;
The isn't very useful as it puts a "Returns" into my HTML documentation and the second one breaks my code!
How do I remove this warning?
Thanks
Matt
© Stack Overflow or respective owner