Proyecto Fin de Carrera

Robótica, software y telecomunicaciones.

Autodia y Doxygen aplicado a RoboComp

Hace varios meses os hablé de Dia , Autodia y Doxygen. Hoy os contaré cómo podemos aplicar estas herramientas de documentación a RoboComp.

Primero tengo que decir que Doxygen ya estaba integrado en RoboComp cuando llegué a RoboLab, y esto me fue de gran ayuda para empezar a programar en RoboComp. Doxygen soporta LaTeX siempre que tengas instaladas las oportunas dependencias en tu sistema, para instalarlas sólo ejecuta el siguiente comando:

sudo aptitude install latex dvips gs

Hasta el momento no he documentado mi componente con Doxygen pero en RoboLab lo tienen configurado para que una vez a la semana Doxygen examine todo el código que hay en el repositorio y genere la documentación que se publica en RoboComp API.

Para empezar a documentar con Doxygen tomaré ideas de otros componentes que ya estén documentados a la vez que me ayudo de los manuales de Doxygen.

Por otro lado he estado probando Autodia, el cual es bastante fácil de usar, aunque aún no he conseguido comprender porqué no puede procesar algunos archivos y otros sí. De momento he aplicado Autodía a mi componente leandroComp (ya le cambiaré el nombre a camimicComp) sacando un bonito gráfico con los métodos y variables utilizadas.

Para instalar Autodia simplemente ejecutarmos el siguiente comando en la consola:

sudo aptitude install autodia

Para ejecutarlo basta con llamarlo así:

autodia

Entonces te saldrá una pantalla explicando las distintas opciones posibles, si teneis alguna duda, espero vuestros comentarios.

Anuncios

3 abril 2011 Posted by | all | , , , , | Deja un comentario

Información para programar

La información que podemos obtener en la API de Robocomp, en QTAssistant, o en la wiki de OpenCV es realmente útil y necesaria para mi PFC, sin embargo, tenía la necesidad de obtener de forma resumida la información que necesitaba.

Para casi cualquier tema podréis encontrar en internet unas hojas a modo de chuleta que sintetizan la información necesaria, simplemente buscando en google “cheatsheet tema” o “tema reference” obtendremos muchos enlaces que nos llevan a archivos pdf de pocas páginas.

Yo he estado buscando de los temas relacionados con mi proyecto y me gustaría compartilos con vosotros:

  • ASCII Reference: Muy útil para escribir caracteres ASCII por el terminal, o manipular caracteres.
  • C Reference: Aunque vaya a usar C++, no viene nada mal tener a mano este documento.
  • C++ Reference: Es útil cuando empezamos con C++, luego ya esto te lo conoces como la palma de tu mano.
  • SVN Reference: No sé si ya he mencionado a Subverson antes, pero es un controlador de versiones de código, usamos un servidor en Robolab y también otro en la forja RedIris.
  • OpenCV Reference: De momento es la que mejor me viene, pues no termino de sentirme cómodo con la documentación oficial de OpenCV.
  • LaTeX Reference: Es ideal para mí, ya que quiero documentar todo mi PFC con LaTeX sin haberlo usado anteriormente.
  • UML Reference: En unos de mis primeras entradas publiqué mi intención de usar diagrmas UML para explicar mi código, sé que siempre debería dibujar los gráficos UML antes que generar código, sin embargo me temo que tendré que hacerlo al revés, espero que con la ayuda de este archivo me sea más fácil.

Pero no todo iban a ser chuletas, éstas son sólo un apoyo, el resto se aprende programando, pidiendo ayuda y consejo a compañeros de Robolab y mi tutor del PFC, buscando información en libros, blogs, foros…

A continuación os dejo una lista de libros o manuales que estoy utilizando para aprender:

  • Aprende C++ como si estuviera en primero.
  • Aprende UML en 24 horas.
  • Robocomp for Dummies.
  • Robex and Robocomp: Building intelliget robots.
  • Distribuited Programming with ICE.
  • Metodología para el desarrollo de aplicaciones orientadas a objetos.
  • Programación vanzada en Shell.

27 febrero 2011 Posted by | all | , , , | Deja un comentario

   

A %d blogueros les gusta esto: