[Documentación de Software] Doxygen - Parte 2

Estuve investigando un poco más acerca de Doxygen, y aprendí a utilizarlo. Más adelante voy a subir un video-tutorial. Por el momento, doy una explicación rápida.

Para que Doxygen te genera la documentación de forma correcta, hay que tener cierto formato para comentar los métodos, las clases, etcétera. Explicaré ese formato a través de unos ejemplos:

class Persona
{
    public:
        //! Descripción corta.
        /** Descripción detallada/larga.
        * \param abc: Parámetro que sirve para ...
        * \return Retorna a ...
        */
        int A(int abc);

        /**
        * \brief Descripción corta.
        * 
        * Descripción detallada. Este formato es equivalente al de arriba.
        * 
        * @param cba: ...
        * @return Retorna a la nada misma...
        */
        int B(int cba);
};

Este formato se usa tanto para describir clases, como para describir métodos, archivos, etc.

Además de "param", "brief", y "return", existen otras palabras clave utilizadas para documentar. Se puede establecer el autor, utilizando la palabra "author" seguida del nombre del autor. Hay varias, se encuentran todas en internet dando vueltas..

Después, se pueden emplear códigos html para extender el formato de las descripciones, ejemplos:

/**
* \brief Ejemplos de usos de html en descripciones.
*
* Si yo en una descripción detallada, quiero dejar un renglón, simplemente
* haciendo esto que acabo de hacer (tocar "enter" para cambiar de línea), 
* no funciona, simplemente Doxygen escribe todo contínuamente. Para que 
* Doxygen haga un salto de línea, hay que escribir la etiqueta: 
* Si deseo escribir un texto en negrita, simplemente lo encierro entre 
* texto en negrita. Para la cursiva, texto en cursiva.
* Otro ejemplo útil es el de listado:
* 
* 
 Item 1. 
* 
 Item 2. 
* 
 Item 3. 
* 
*/

Bueno, por hoy llego hasta acá. Espero que la información haya sido útil. Saludos!

PD: el código de "Ejemplos de usos de html en descripciones" se buguea en el post porque utilizo códigos html, espero que igual sea entendible.