Guía de Doxygen en modo gráfico

Doxygen es un generador de documentación muy útil para la Ingeniería Electrónica, ya que soporta, entre otros, los lenguajes C y VHDL.

Doxygen puede ser utilizado por línea de comandos, sin embargo al empezar puede ser interesante usar el asistente gráfico, para suavizar la curva de aprendizaje.

Para seguir la guía, debes crear un fichero .c con los comentarios de Doxygen en la carpeta que especifiques como “Source code directory”. Puedes utilizar este fichero de ejemplo:

/*!
 * @file    main.c
 * @author  Hipolito Guzman
 * @date    26 Nov 2013
 */

/*!
 * @addtogroup common
 * @{
 * @defgroup common_helloworld Hola Mundo
 * @{
 * @brief Prints "Hola, mundo" in the console
 *
 * Extended description goes here
 */

#include <stdio.h>

/*!
 * @param void Receives no parameter
 * @return 0, everytime
 * @todo Translate printed message to English
 * @bug Text appears in Spanish, should appear in English
 * @brief main() function of the program
 */
int main (void)
{
  printf("Hola, mundo!!\n");

  return 0;
}

/*!
 * @}
 * @}
 */

A continuación puedes encontrar la guía. Además, en la documentación de Doxygen puedes encontrar más información acerca de la sintaxis que hay que utilizar en los comentarios.

Leave a Reply

Your email address will not be published. Required fields are marked *