TP 3
TP 3
TP 3
Objetivos
Conocer la metodología de documentación de aplicaciones utilizando Doxygen
Que sea capaz de documentar aplicaciones de modo efectivo.
Herramientas requeridas
Para el desarrollo del presente trabajo práctico deberá contar con:
Doxygen
1. Documentación de aplicaciones
Doxygen permite la documentación de aplicaciones en diferentes lenguajes, en el caso particular
del lenguaje C no permite extraer documentación desde implementación de funciones. Pero si
permite que el algoritmo implementado en una función sea documentado utilizando los métodos
estándares previstos en el lenguaje. En las actividades siguientes se pretende aplicar la metodología
de documentación propuesta por doxygen en dos casos típicos.
Actividades:
Dentro del directorio raíz del proyecto cree una nueva carpeta llamada ‘doc’. Utilice la
aplicación doxywizard para crear la configuración básica para la documentación y guárdela
la carpeta doc con el nombre propuesto.
De la pestaña Wizard configure las opciones Proyect con los valores correspondientes. En
la opción Mode seleccione All Entities, Include cross-referenced source code in the output y
seleccione Optimized for C or PHP output.
En la pestaña Output seleccione:
HTML y with navigation panel.
LaTex y as intermediate format for hyperlinked PDF
Man pages
Rich Text Format
XML
En la pestaña Expert establezca como lenguaje a utilizar (OUTPUT_LANGUAGE ) Spanish.
Desde la pestaña Run genere la documentación y verifique la salida HTML obtenida. Analice
la correlación entre los comentarios realizados y la salida obtenida.
Tras generar la documentación se crearon las carpetas:
html: con la documentación html. El punto de entrada (índice) para la documentación
será el archivo index.html.
latex: dentro de esta carpeta encontrará los archivos de código latex que pueden ge-
nerar un pdf con la documentación correspondiente. Estos archivos ya se encuentran
vinculados por un makefile que también se ha generado. Ejecute el comando make
dentro de esta carpeta y verifique la creación de un archivo denominado refman.pdf
Utilizando TeXstudio u otro editor de documentación LATEXde su preferencia observe
el contenido del archivo refman.tex.
man: aquí encontrará las páginas del manual generadas automáticamente. Puede utilizar
el comando man desde la terminal para visualizar el contenido de estos archivos.
rtf: documentación en formato Texto Enriquecido. Puede revisar el contenido de este
documento utilizando diversos editores de texto, entre ellos LibreOffice Writer y MS
Word.
xml: documentos xml conteniendo la documentación extraída para ser utilizada por
otras herramientas para personalizar la documentación generada.
3. Documente el ejercicio 7 de la guía de Trabajos Prácticos II, para esto copie el proyecto a
un nuevo directorio.
Utilice las etiquetas addtogroup, file y brief para documentar el header utils.h como módulo
de software. Agregue documentación para cada una de las funciones desarrolladas, incluyendo
la descripción de sus argumentos (param[in],param[out] y/o param[in|out] ) y valor de retorno
return.
Agregue también la definición de una constante simbólica y documéntela de forma adecuada.
En lo que respecta al archivo main.c agregue una página principal de documentación inclu-
yendo cuando menos 2 secciones y un registro de cambios.