Documentación en Doxygen

Buenas,

Hoy os hablaré un poquito sobre doxygen una herramienta bestial para hacer documentación de librerías y programas.

Doxygen parsea los archivos de código fuente de vuestros programas en C++ (también acepta otros lenguajes, unos cuantos más en realidad) y analiza el árbol de clases de vuestro proyecto para crear la documentación. Además, si habéis sido buenos chicos y habéis comentado qué hace cada función justo encima de la declaración es capaz de leerlo y añadirlo al manual.

El manual queda genial, te lo exporta en HTML y en LateX con un formato bastante chulo. Qt-GStreamer, por ejemplo, tiene su documentación hecha en doxygen (sin tocar nada, sale así directamente) y el formato de LateX también está muy bien.

Es muy sencillo de usar, simplemente lo instaláis (seguramente lo tendréis ya sin saberlo, como me pasó a mí) y ejecutáis:

$ doxygen -g <nombre_del_archivo>

Y eso os crea un archivo de configuración básico con el nombre que habéis elegido, que tenéis que editar para decirle qué tipo de archivo tiene que leer y cuál no y podéis configurar miles de opciones. En el propio archivo os dice que hace cada opción y os muestra el valor por defecto (hay opciones por un tubo, no os asustéis 🙂 ). Por ejemplo:

...

FILE_PATTERNS          = *.cpp *.h
RECURSIVE              = YES
...

Una vez lo hayáis definido todo bien, lanzáis el programa haciéndole referencia al archivo que habéis preparado y se pone a trabajar:

$ doxygen <nombre_del_archivo>

Y listo!

Os crea una carpeta con HTML y otra con LateX (si no lo habéis quitado). La de LateX tenéis que hacer un Make después para que os prepare el documento final que se suele llamar refman.pdf. Es muy interesante este caso porque es un PDF con hipervínculos muy chulos para poder analizar el documento con más facilidad.

En fin, probadlo, a mí me ha encantado y me ha venido muy bien para analizar las clases de forma rápida sin tener que leer un montón de código.

Saludos!

 

 

Anuncios

Un pensamiento en “Documentación en Doxygen

  1. Libmatthread: Mi nueva librería y locura matemático-matricial en C – Free Hacks!

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s