Documenta tu proyecto con doxygen y doxygen-gui

Este es uno de esos programa de los de... como no lo conocí esto antes... Si, Doxygen es una herramienta de generación de documentación para código fuente. Es una herramienta gratuita y de código abierto que se puede usar para generar documentación en HTML, LaTeX, RTF, PDF y otros formatos.

Es genial si tienes que compartir código con otros miembros de un equipo de trabajo o para recordar que hacía ese código que escribiste hace años. Otra ventaja es que en la mayoría de las distribuciones ya lo tienen incluido en sus repositorios.

Instalación desde repositorios Ubuntu

Para instalar Doxygen solo tienes que abrir una terminal y ejecuta el siguiente comando:

sudo apt install doxygen

Este comando instalará la última versión estable de Doxygen en tu sistema.

Instalación desde binarios

Si quieres instalar una versión específica de Doxygen, puedes descargar los binarios desde la página web oficial de Doxygen: https://www.doxygen.nl/download.html

Una vez que hayas descargado los binarios, descomprime el archivo y ejecuta el siguiente comando para instalar Doxygen:

./doxygen-X.Y.Z/bin/install

Reemplaza X.Y.Z con la versión de Doxygen que hayas descargado.

Podemos verificar que Doxygen se ha instalado correctamente solo con ejecutar el siguiente comando:

doxygen --version

Este comando debería mostrar la versión de Doxygen que está instalada en tu sistema.

Doxygen también tiene una interfaz gráfica de usuario (GUI) llamada Doxywizard. Con ella podrás configurar de manera visual parametros como la carpeta donde están las fuentes, el código que se analiza, hasta un icono para hacer más bonito el documento final

Puedes instalarla con el siguiente comando:

sudo apt install doxygen-gui

y para ejecutar Doxygen de manera gráfica:

doxywizard

Doxywizard te permite crear y editar archivos de configuración de Doxygen de forma gráfica.

Gráficos en tu documentación

Con Doxygen también podemos generar gáficos, pero para esto necesitamos tener instalado graphviz. Podemos instalarlo desde el terminal con el comando:

sudo apt install graphviz

Ejemplo de uso sin interfaz gráfica

Para generar documentación con Doxygen, necesitas crear un archivo de configuración llamado Doxyfile.

Este archivo contiene información sobre tu proyecto, como la ubicación del código fuente, los formatos de salida que deseas generar y las opciones de configuración de Doxygen.

A continuación, puedes ejecutar el siguiente comando para generar la documentación:

doxygen Doxyfile

Este comando generará la documentación en el directorio especificado en el archivo

Doxyfile

Doxygen es una herramienta poderosa para generar documentación de código fuente. Es fácil de instalar y usar, y ofrece una amplia gama de opciones de configuración.

Para obtener más información sobre Doxygen, puedes consultar la documentación oficial: https://www.doxygen.nl/manual/