Mi proyecto Doxygen de prueba  v1.0
Referencia del Archivo ejemplo_doxygen.h

Este es un ejemplo de uso de doxygen como herramienta de documentación para el curso de Sistemas Embebidos. Más...

Ir al código fuente de este archivo.

'defines'

#define C1   1
 
#define LBUF   80
 

'typedefs'

typedef MiTipo int
 
typedef int(* ShellFunPtr) (unsigned int argc, char **argv)
 

Funciones

int sumar (int a, int b)
 

Variables

bool intEnabled
 

Descripción detallada

Este es un ejemplo de uso de doxygen como herramienta de documentación para el curso de Sistemas Embebidos.

Proyecto Ejemplo Modulo Ejemplo Este modulo agrupa las funciones de tal tipo que hacen tal o cual categoria de cosas

Los comentarios que aparecen en este archivo se refieren a la funcionalidad y la interface del modulo. Nunca a su implementacion.

ejemplo.h El programa tal, que hace esto y lo otro...

Autor
Tito Livio tliv@.nosp@m.exam.nosp@m.ple.c.nosp@m.om
Versión
1.1 Se corrige Bug#0001 en la implementacion de sumar
Fecha
27 Marzo 2014
Autor
yo@fi.nosp@m.ng.e.nosp@m.du.uy
Versión
1.2 Se corrige Bug#0002 y Bug#0003 en la implementacion de Doxygen
Fecha
30 Marzo 2017

Definición en el archivo ejemplo_doxygen.h.

Documentación de los 'typedefs'

typedef MiTipo int

Defino tipo para alguna cosa

Definición en la línea 47 del archivo ejemplo_doxygen.h.

typedef int(* ShellFunPtr) (unsigned int argc, char **argv)

Defino tipo para funciones a llamar con interface std (esto es parte de otro ejemplo y no importa el detalle)

Definición en la línea 53 del archivo ejemplo_doxygen.h.

Documentación de las funciones

int sumar ( int  a,
int  b 
)

<Una descripción="" corta>=""> Ejemplo: Suma dos enteros

Parámetros
inta: Descripción de un parámetro de entrada de la función
intb: El otro sumando
Devuelve
int Descripción del valor de retorno de la función (si lo hay)

suma 2 enteros

Si hay un comentario aca deberia ser muy breve. La interface debe comentarse en el .h para no tener que mantener coherencia entre el .c y el .h

Definición en la línea 36 del archivo ejemplo_doxygen.c.

Documentación de las variables

bool intEnabled

TRUE si las interrupciones está habilitadas

Definición en la línea 56 del archivo ejemplo_doxygen.h.