Doxygen
Doxygen
Doxygen
Herramientas de Documentación
Doxygen
Alejandro Furfaro
Marzo 2011
Introducción Configuración Generando la documentación Preparando el código para su documentación
Temario
1 Introducción
2 Configuración
3 Generando la documentación
4 Preparando el código para su
documentación
¿Que es doxygen?
Instalación
sudo apt−g e t i n s t a l l k a t e
Instalación
sudo apt−g e t i n s t a l l k a t e
doxygen −g
Doxyfile
Parámetros de interés
Parámetros de interés
Parámetros de interés
doxygen D o x y f i l e
/∗ ∗
∗ E s t i l o JavaDoc : I n i c i a r con ’ / ∗ ∗ ’
Apto para programas en C
Los a s t e r i s c o s i n t e r m e d i o s son o p c i o n a l e s
∗/
/∗ !
∗ E s t i l o QT
Los a s t e r i s c o s i n t e r m e d i o s son o p c i o n a l e s
∗/
// /
/ / E s t i l o C++
/∗ ∗
\ f i l e programa . c
\ b r i e f Este a r c h i v o c o n t i e n e e l programa
principal
\ d e t a i l s Aqui nos explayamos sobre l a t a r e a
que r e a i z a r e l programa o l a
funci n
\ a u t h o r A l e j a n d r o F u r f a r o a f u r f a r o @ i e e e . org
\ date 30 de Marzo de 2011
\ version 1.0.0
∗/
Documentando variables
Versión compacta:
unsigned char B u f f e r [ B u f f e r s i z e ] ; / / !< B u f f e r para r e c i b i r c
Versión extendida
/∗ ∗
\ v a r unsigned char B u f f e r [ B u f f e r s i z e ] ;
\ b r i e f B u f f e r para r e c i b i r c a r a c t e r e s
\ d e t a i l s Aqui s i es n e c e s a r i o podemos e x pl a y ar n o s
acerca de l a v a r i a b l e .
∗/
unsigned char B u f f e r [ B u f f e r s i z e ] ;
Documentando variables
Estructuras
/∗ ∗
\ s t r u c t coordenada
\ b r i e f V a r i a b l e para almacenar un par de coordenadas ( x , y )
\ d e t a i l s Aqui s i es n e c e s a r i o podemos e x pl a y ar n o s
acerca de l a e s t r u c t u r a .
∗/
s t r u c t coordenada {
i n t x ; / / !< Coordenada x ;
i n t y ; / / !< Coordenada y ;
};
Documentando variables
En general
\ struct
\enum
\union
\ class
\ def
\ typedef