开发者

Doxygen - <X>:1: warning: return type of member X is not documented

开发者 https://www.devze.com 2023-02-09 20:21 出处:网络
/*! \\varGLOBAL_VAR *\\briefThis is my global initialisation array for MY_STRUCT */ MY_STRUCT GLOBAL_VAR = {
/*! \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  T开发者_C百科his 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


http://old.nabble.com/%22warning:-return-type-not-documented%22-for-non-functions-td29022040.html

Seems a bug. Hopefully it'll be fixed in the future.

0

精彩评论

暂无评论...
验证码 换一张
取 消