Manual Doxygen

Manual de uso de
Documentación automática de C++ estándar
mediante Doxygen
http://www.doxygen.org/

Índice
1Introducción........................................................................................................................................32Instalación...........................................................................................................................................3
3Obtener la documentación de un proyecto.........................................................................................4
4Documentar un proyecto....................................................................................................................6

1 Introducción
Doxygen es un documentador automático, capaz de extraer la documentación de los propiosfuentes
del programa. Es capaz de extraer documentación especialmente de Java, C y C++, si bien otros
lenguajes como Python también están soportados. En este documento se describe de manera sencilla
las operaciones más comunes con esta herramienta: el formato de los comentarios en el código
fuente (el pequeño precio que hay que pagar para poder disfrutar de estas ventajas), la configuraciónde Doxygen y su ejecución para la obtención de la documentación.
Doxygen se basa principalmente en JavaDoc, una herramienta que desde finales de los años
90 se distribuye con el lenguaje de programación Java, y que funciona exactamente de la misma
forma (si bien Doxygen cubre muchos más lenguajes y aporta mucha más funcionalidad).

2 Instalación

Figura 1: Doxywizard, la interfaz gráfica deDoxygen
Si bien Doxygen1 es una herramienta de línea de comando, al que hay que pasarle un archivo de
configuración preparado para el proyecto previamente, el trabajo se alivia bastante empleando
Doxywizard, una interfaz gráfica para Doxygen que se instala automáticamente con la versión para
windows, pero que hay que instalar aparte (doxygen-gui) en entornos Linux. Su aspecto en todos lossistemas (incluyendo también Mac), es el que se muestra en la figura 1.
Para su correcto funcionamiento, precisa del paquete de diagramación GraphViz2, que en
entornos Linux se instala de manera muy sencilla según la distribución usada, pero que en entornos
Windows es necesario retocar para su correcta disponibilidad. Para que Doxygen encuentre a
GraphViz, es necesario que éste último seencuentre en las rutas del sistema, almacenadas en la
variable PATH. Así, una vez instalados ambos paquetes (supongamos en la unidad C:), será
necesario ejecutar las siguientes órdenes para trabajar correctamente.
set PATH=c:\archivos de programa\graphviz\bin\;%PATH%
doxywizard
1 http://www.doxygen.org
2 http://www.graphviz.org

En caso de que no se instale el paquete GraphViz, se pierden losgráficos de llamadas a
funciones, lo cuál tampoco es vital si no se precisa.

3 Obtener la documentación de un proyecto
La manera más sencilla para trabajar con Doxygen es utilizar el Wizard (asistente). Durante esta
sección se asumirá que se desea documentar un proyecto de gestión temperaturas que reside en un
directorio llamado GestionTemperaturas. Si se pulsa en el botón Wizard (figura 2),aparece el
asistente que nos permitirá obtener la documentación del proyecto.
En primer lugar, se pregunta el título de la documentación, en project name. Lo más
importante aquí, en cualquier caso, es indicar el lugar donde residen los fuentes (source code
directory), así como el lugar donde se va a generar la documentación (desination directory). Una
buena idea es crear un subdirectoriodentro del directorio del proyecto (como doc, en el ejemplo),
de manera que siga estando todo localizado en un mismo lugar.

Figura 2: Utilizando el asistente para configurar Doxygen
A continuación, se selecciona el lenguaje de programación a emplear para el proyecto
(figura 3). En realidad, Doxygen genera la documentación en cualquiera de las formas, pero
seleccionando el lenguaje de...