Scribd Logo
Cargar

¡Te damos la bienvenida a Scribd!

  • 45 vistas

    TP 3

    Cargado por

    Abraham Gutierrez
    Este documento presenta un trabajo práctico sobre la documentación de aplicaciones usando Doxygen. El objetivo es conocer la metodología de documentación de Doxygen y ser capaz de documentar aplicaciones de forma efectiva. Se deben documentar dos proyectos de ejemplo usando etiquetas como \mainpage, \brief, \param y \return. La documentación generada por Doxygen se almacenará en formatos HTML, LaTeX, manuales y XML para su revisión.

    Copyright:

    © All Rights Reserved
    Descargue como PDF, TXT o lea en línea desde Scribd

    TP 3

    Cargado por

    Abraham Gutierrez
    45 vistas3 páginas
    Este documento presenta un trabajo práctico sobre la documentación de aplicaciones usando Doxygen. El objetivo es conocer la metodología de documentación de Doxygen y ser capaz de documentar aplicaciones de forma efectiva. Se deben documentar dos proyectos de ejemplo usando etiquetas como \mainpage, \brief, \param y \return. La documentación generada por Doxygen se almacenará en formatos HTML, LaTeX, manuales y XML para su revisión.

    Descripción original:

    Título original

    tp3

    Derechos de autor

    © © All Rights Reserved

    Formatos disponibles

    PDF, TXT o lea en línea desde Scribd

    ¿Le pareció útil este documento?

    ¿Este contenido es inapropiado?

    Este documento presenta un trabajo práctico sobre la documentación de aplicaciones usando Doxygen. El objetivo es conocer la metodología de documentación de Doxygen y ser capaz de documentar aplicaciones de forma efectiva. Se deben documentar dos proyectos de ejemplo usando etiquetas como \mainpage, \brief, \param y \return. La documentación generada por Doxygen se almacenará en formatos HTML, LaTeX, manuales y XML para su revisión.

    Copyright:

    © All Rights Reserved
    Descargue como PDF, TXT o lea en línea desde Scribd
    Descargar como pdf o txt
    45 vistas3 páginas

    TP 3

    Cargado por

    Abraham Gutierrez
    Este documento presenta un trabajo práctico sobre la documentación de aplicaciones usando Doxygen. El objetivo es conocer la metodología de documentación de Doxygen y ser capaz de documentar aplicaciones de forma efectiva. Se deben documentar dos proyectos de ejemplo usando etiquetas como \mainpage, \brief, \param y \return. La documentación generada por Doxygen se almacenará en formatos HTML, LaTeX, manuales y XML para su revisión.

    Copyright:

    © All Rights Reserved
    Descargue como PDF, TXT o lea en línea desde Scribd
    Descargar como pdf o txt
    de 3

    Trabajo Práctico III

    Fundamentos de Programación de Sistemas Embebidos


    Especialización en Sistemas Embebidos
    Cohorte 2018
    Trabajo Práctico III Fundamentos de Programación de Sistemas Embebidos

    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:

    Equipo PC utilizando Linux como sistema operativo.


    La suite de desarrollo de GNU, incluyendo binutils, gcc y make (paquete build-essential en
    distribuciones basadas en debian).
    Eclipse IDE for GNU ARM (versión recomendada Oxygen 3a)

    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:

    1. Consulte la documentación de doxygen (https://www.stack.nl/ dimitri/doxygen/manual/index.html)


    y comente la forma de documentar el código fuente utilizando:
    Fragmentos de código de ejemplo.
    Imágenes
    Enlaces (\ref y \cite)
    Realice una aplicación de ejemplo donde haga uso de estas etiquetas.
    2. Cree una copia del proyecto desarrollado en el ejercicio 5 del Trabajo Práctico II. Documente
    la aplicación dentro del archivo main.c, incluyendo como mínimo las etiquetas:
    \mainpage: Agregue como mínimo 2 secciones, donde conste la descripción general de
    la actividad y sus datos personales. A continuación de estos una tabla de registro de
    cambios.
    brief: Realice una descripción breve y una extendida de la tareas que resuelve la
    aplicación.
    param y return: Documente el sentido que tienen los argumentos de la función main y
    el sentido del valor retornado.
    Agregue comentarios dentro de la función main, a modo de documentación, que explique el
    funcionamiento del algoritmo.
    Excepcionalmente, con el fin de probar la documentación de variables, mueva la declaración
    de las variables utilizadas en la aplicación fuera de main y documente su significado en el
    dominio de la aplicación.

    Mg. Ing. E. Sergio Burgos 1


    Trabajo Práctico III Fundamentos de Programación de Sistemas Embebidos

    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.

    Mg. Ing. E. Sergio Burgos 2

    También podría gustarte