Introducción a Doxygen

Doxygen es un documentador automático, capaz de extraer la documentación de los propios fuentes del programa.

Instalación Doxygen

Apt-get install doxygen doxygen-doc doxygen-gui graphviz

Comentar el código para incluir tags doxygen

Los tags de doxygen deben estar dentro de lineas comentadas en el código,

comentario normal C	comentario doxygen para C
/* lineas comentadas */	* comentarios para doxigen */
comentario de linea	/ comentario de linea para doxigen

comentario normal bash	comentario doxygen para bash
# comentario de linea	#* # comentarios para doxigen #*/

Modificaciones especiales para el lenguaje bash

Doxygen está preparado para documentar C, y no bash. En muchas ocasiones utilizamos en bash, /* para muchas operaciones, pero doxygen lo va a interpretar como comentario del fuente y si no encuentra un */ (fin comentario) tendremos errores. Cuando estemos programando y tenemos la intención de autodocumentar con Doxygen, debemos de tener en cuenta: Si utizamos los caracteres que se utilizan para comentar en C ( /* ) debemos de colocar despues # */ Requisito para Doxygen. Por ejemplo

# este comentario de bash es para indicar que en la linea siguiente, debemos de colocar dentro de un comentario bash el fin de comentario C, 
# ya que la instrucción cp utiliza los caracteres que usa C para iniciar comentarios.
cp origen/* /destino   # */ Requisito para Doxygen 

tag de doxygen

Ejemplos

Ejemplo de documentacion

Ejemplo de salida documentación