Beruflich Dokumente
Kultur Dokumente
4 de abril de 2008
()
4 de abril de 2008
1 / 16
Introduccin
()
4 de abril de 2008
2 / 16
Qu es Doxygen?
Sistema de documentacin para: C++, C, Java, Objective-C, Python,
IDL, Fortran, VHDL, PHP, C#
Posibilidades:
Extrar la estructura del cdigo fuente de un conjunto de ficheros que
no han sido expresamente preparados para Doxygen
Generar documentacin a partir de un cojunto de ficheros de cdigo
expresamente documentados al estilo Doxygen
Otras.
Formatos de salida soportados:
HTML
LATEX
RTF
Postscript, PDF
Unix man pages
Windows help compressed HTML
XML
http://www.stack.nl/~dimitri/doxygen/
()
4 de abril de 2008
2 / 16
Instalacin
# LaTeX
# Dibujar clases
$ a p t i t u d e i n s t a l l doxygeng u i # Opcional
$ a p t i t u d e i n s t a l l doxymacs
# Usa e l mejor e d i t o r ; )
()
4 de abril de 2008
3 / 16
()
4 de abril de 2008
4 / 16
EXTRACT_ALL = YES
()
4 de abril de 2008
5 / 16
4 de abril de 2008
6 / 16
()
4 de abril de 2008
7 / 16
INPUT
FILE_PATTERNS
GENERATE_HTML
GENERATE_LATEX
EXTRACT_ALL
=
=
=
=
=
octave 3 . 0 . 0 / l i b o c t a v e
.h
YES
NO
YES
4 de abril de 2008
8 / 16
Observaciones
Doxygen genera numerosos enlaces de forma automtica:
Listado de ficheros
Listados de clases (alfabtico/jeraquizado) y de miembros
En cada clase:
Enlace al fichero fuente
Enlace a documentacin de cada miembro
...
4 de abril de 2008
9 / 16
Generar documentacin:
1
2
Con HAVE_DOT = NO
Con HAVE_DOT = YES
()
4 de abril de 2008
10 / 16
Una v a r i a b l e s i m p l e
/
i n t s i m p l e =0;
4 de abril de 2008
11 / 16
// /
/ / / Comentarios C++ con una b a r r a a d i c i o n a l
// /
/ / /
Un comentario muy v i s i b l e
/
()
4 de abril de 2008
12 / 16
Si JAVADOC_AUTOBRIEF=YES
/ La descripcin breve termina con un punto, como ste. El resto
es la documentacin detallada, bla, bla, bla...
/
()
4 de abril de 2008
13 / 16
()
4 de abril de 2008
14 / 16
Ejemplo 3...
/
};
()
4 de abril de 2008
15 / 16
Ejemplo 3...
/
};
()
4 de abril de 2008
16 / 16
ftp://ftp.stack.nl/pub/users/dimitri/doxygen_manual-1.
5.5.pdf.zip
()
4 de abril de 2008
17 / 16