¿De qué atributos de clase de un documento utilizando Doxygen?

Question

Estoy tratando de atributos de clase de documento utilizando Doxygen. Actualmente, los atributos protegidas aparecen en la lista en la parte superior de la página para la clase específica. Me gustaría poner una explicación para ellos.

He intentado usar @param [name] [description] tanto por encima como el inicio de la clase y justo encima de la declaración de los atributos. Incluso he intentado ponerlos en el bloque de documentación para mi clase de constructor y que sólo se rompió.

¿Hay algo que simplemente me falta?

- Logan

Answer 1

Usted tiene que usar < o comentario justo antes de que el atributo:

class cMainData
{
    private $attr;  //!< This is my attribute

    //! This is another attribute
    private $otherAttr;
}

Tenga en cuenta que puede utilizar @brief, @note y similares por ejemplo:.

class cMainData
{
    private $attr;  //!<@brief This is my attribute.
                    //!< This is some additional info about this attribute.
}

Answer 2

He publicado una solución como una respuesta a un duplicado de esta pregunta: Doxygen:?. ¿Cómo describir las variables miembro de clase en php puede ser útil para enlazar desde aquí a los demás que la solución necesidad compatible con el estilo phpDoc anotación