Doxygen - <X>: 1: предупреждение: тип возврата элемента X не задокументирован - PullRequest
Новая
       5

Doxygen - <X>: 1: предупреждение: тип возврата элемента X не задокументирован

1 голос
/ 08 февраля 2011 
/*! \var    GLOBAL_VAR
 *  \brief  This is my global initialisation array for MY_STRUCT
 */
MY_STRUCT GLOBAL_VAR = {
    1,
    3,
    2,
    1,
};

Я получаю следующую ошибку: 

<GLOBAL_VAR>:1: warning: return type of member GLOBAL_VAR is not documented

Но это не должно иметь никакого типа возврата?!

Если я выполню одно из следующих действий, предупреждение исчезнет: 

/*! \var    GLOBAL_VAR
 *  \brief  This is my global initialisation array for MY_STRUCT
 *  \returns
 */
MY_STRUCT GLOBAL_VAR = {
    1,
    3,
    2,
    1,
};

Или: 

/*! \var    GLOBAL_VAR
 *  \brief  This is my global initialisation array for MY_STRUCT
 */
MY_STRUCT GLOBAL_VAR = 3;

Это не очень полезно, так как оно добавляет «Returns» в мою HTML-документацию, а второе - мой код!

Как мне удалить это предупреждение?

Спасибо

Мэтт

1 Ответ

0 голосов
/ 16 февраля 2011

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

Кажется, ошибка.Надеюсь, это будет исправлено в будущем.

...