Mi proyecto Doxygen de prueba
v1.0
Página principal
Estructuras de Datos
Archivos
Lista de archivos
Globales
Todo
Estructuras de Datos
Archivos
Funciones
Variables
'typedefs'
'defines'
DoxygenReadme.h
Ir a la documentación de este archivo.
1
// IMPORTANTE LEER ESTO ANTES DE EMPEZAR
3
//
4
// Este archivo explica el uso de Doxygen orientado a aplicaciones
5
// en C. Se debe tener instalado Doxygen y se recomienda usar el
6
// wizard de Doxygen, doxywizard.
7
// Ver http://www.stack.nl/~dimitri/doxygen/index.html.
8
//
9
// Para generar la documentacion primero se debe generar un Doxyfile.
10
//
11
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
12
// Ver Doxyfile adjunto para ver qué campos se pueden configurar.
13
// !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
14
//
15
// En el wizard, pestaña expert, tenemos todos estos campos y si nos
16
// paramos arriba de cada uno tenemos una descripcion de que es lo
17
// que hace en una ventanita auxiliar.
18
//
19
// Se debe configurar el formato de los archivos de salida, así como
20
// el directorio del que se sirve los archivos para incluir en la
21
// documentacion y los tipos de archivo que incluye (*.h, *.c).
22
// Tambien se pueden configurar muchas mas cosas, como el idioma,
23
// ver como esta configurado el archivo Doxyfile adjunto como
24
// referencia.
25
//
26
// Cuando estamos satisfechos con la configuracion vamos a la pestaña
27
// Run y hacemos Run doxygen. Podemos ver la salida en formato HTML
28
// pulsando un boton que aparece abajo.
30
57
#define MI_MACRO 1
58
59
#ifndef DOXYGEN_SHOULD_SKIP_THIS
60
61
// codigo que Doxygen se debe saltear. Para que funcione, seteamos
62
// en el Doxyfile: PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS
63
#if MI_MACRO
64
#define PRINTF(...) printf(__VA_ARGS__)
65
#else
66
#define PRINTF(...)
67
#endif
68
69
#endif // DOXYGEN_SHOULD_SKIP_THIS
70
71
73
typedef
void (
function_t
)();
74
75
79
typedef
union
{
80
unsigned
char
byte
;
81
struct
{
82
unsigned
char
bit0 : 1;
83
unsigned
char
bit1 : 1;
84
unsigned
char
bit2 : 1;
85
unsigned
char
bit3 : 1;
86
unsigned
char
bit4 : 1;
87
unsigned
char
bit5 : 1;
88
unsigned
char
bit6 : 1;
89
unsigned
char
bit7 : 1;
90
} bit;
91
struct
{
92
unsigned
char
nibble0 : 4;
93
unsigned
char
nibble1 : 4;
94
} nibble;
95
}
registro_t
;
96
97
102
static
int
numero
;
103
114
int
operar
(
int
a,
int
b);
function_t
void( function_t)()
Definition:
DoxygenReadme.h:73
registro_t
Definition:
DoxygenReadme.h:79
operar
int operar(int a, int b)
Resumidamente esto hace mi funcion operar.
numero
static int numero
Definition:
DoxygenReadme.h:102
registro_t::byte
unsigned char byte
Definition:
DoxygenReadme.h:80
DoxygenReadme.h
Generado el Jueves, 30 de Marzo de 2017 18:28:07 para Mi proyecto Doxygen de prueba por
1.8.6