¿Cómo debo clasificar un typedef con Doxygen?

Tengo estructuras typedef en mi código C++. A partir de ahora se enumeran como \var typedef. ¿Hay una mejor manera de hacer esto? A continuación se muestra ejemplo de lo que tengo:¿Cómo debo clasificar un typedef con Doxygen?

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

Sé que ni siquiera debería estar diciendo param. ¿Qué más hay para usar?

Fuente

2011-10-28 Questioneer

¿Por qué 'typedef'? Esto es C++, no C. – Pubby

@ Pubby8: 'typedef's todavía se usan en C++ para mejorar la legibilidad del código. Un uso popular de 'typedef' es la creación de punteros a las funciones. Otro es con plantillas. –

@ThomasMatthews Puedo entender el uso de typedef de esa manera, pero ¿por qué 'typedef struct' en lugar de' struct'? – Pubby

Según el Doxygen documentation hay un comando \typedef. El comando se comporta igual que el comando \var.

Fuente

2011-10-28 18:32:20

Si coloca el bloque de comentarios delante del typedef, no necesita usar ningún comando especial.

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

Si prefiere ponerlo después de la typedef utilizar lo siguiente: Sólo

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

cuando el bloque de comentario debe estar en una ubicación diferente que el typedef real, es necesario utilizar \ typedef.

Fuente

2011-10-29 14:46:26 doxygen

¿Cómo debo clasificar un typedef con Doxygen?

Respuesta

Cuestiones relacionadas