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 | , , , ,

Aún no hay comentarios.

Responder

Introduce tus datos o haz clic en un icono para iniciar sesión:

Logo de WordPress.com

Estás comentando usando tu cuenta de WordPress.com. Cerrar sesión / Cambiar )

Imagen de Twitter

Estás comentando usando tu cuenta de Twitter. Cerrar sesión / Cambiar )

Foto de Facebook

Estás comentando usando tu cuenta de Facebook. Cerrar sesión / Cambiar )

Google+ photo

Estás comentando usando tu cuenta de Google+. Cerrar sesión / Cambiar )

Conectando a %s

A %d blogueros les gusta esto: