Mi proyecto Doxygen de prueba
v1.0
|
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 |
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...
Definición en el archivo ejemplo_doxygen.h.
typedef MiTipo int |
Defino tipo para alguna cosa
Definición en la línea 47 del archivo ejemplo_doxygen.h.
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.
<Una descripción="" corta>=""> Ejemplo: Suma dos enteros
int | a: Descripción de un parámetro de entrada de la función |
int | b: El otro sumando |
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.
bool intEnabled |
TRUE si las interrupciones está habilitadas
Definición en la línea 56 del archivo ejemplo_doxygen.h.