Как я должен классифицировать typedef с Doxygen?

Question

В моем коде C ++ есть структуры typedef. На данный момент они перечислены как \var typedef. Есть лучший способ сделать это? Ниже приведен пример того, что у меня есть:

/*! \var typedef etc
 * \brief A type defined structure for etc 
 *
 * \param x type- Variable declaration for x
 * \param y type- Variable declaration for y
 */

Я знаю, что не должен даже говорить param. Что еще можно использовать?

Answer 1

Если вы помещаете блок комментария перед typedef, вам не нужно использовать какую-либо специальную команду.

/** This is the documentation for the following typedef */
typedef MyClass MyTypedef;

Если вы предпочитаете ставить его после typedef, используйте следующее:

typedef MyClass MyTypedef;
/**< This is the documentation for the preceding typedef */

Только когда блок комментариев должен находиться в другом месте, чем фактический typedef, вам нужно использовать \ typedef.

Answer 2

Согласно документации Doxygen существует команда \typedef. Команда действует так же, как команда \var.