ROBODoc

ROBODoc es una herramienta de documentación similar a Javadoc y con licencia GPL . Se utiliza para extraer la documentación de la API del código fuente . Es compatible con cualquier lenguaje que admita comentarios y funciona extrayendo encabezados con formato especial. Estos se reformatean posteriormente a HTML , DocBook , TROFF , ASCII , LaTeX , PDF o RTF .

Se puede utilizar para documentar cualquier artefacto de programación, como por ejemplo: clases, funciones, pruebas, entradas de makefile, etc.

ROBODoc funciona con C , C++ , Fortran , Perl , scripts de shell , Assembler , DCL , DB/C , Tcl/Tk , Forth , Lisp , COBOL , Occam , Basic , HTML , Clarion y cualquier otro lenguaje que admita comentarios.

La primera versión de ROBODoc fue escrita por Jacco van Weert en 1995. ROBODoc se inspiró en el programa Autodocs, disponible para Amiga . Autodocs solo generaba texto en formato ASCII . Jacco creó una versión que generaba texto en formato Amigaguide , lo que permitía crear hipervínculos entre las distintas partes de la documentación.

Un encabezado típico de ROBODoc

/****f* Robodoc/RB_Panic [2.0d]  * SINOPSIS  */ void RB_Panic ( char * cause , char * add_info ) /*  * FUNCIÓN  * Imprime un mensaje de error.  * Libera todos los recursos utilizados por robodoc.  * Finaliza el programa.  * ENTRADAS  * * cause - puntero a una cadena que describe la  * causa del error.  * * add_info - puntero a una cadena con información adicional.  * VER TAMBIÉN  * RB_Close_The_Shop ()  * CÓDIGO FUENTE  */ { printf ( "Robodoc: Error, %s \n " , cause ) ; printf ( " %s \n " , add_info ) ; printf ( "Robodoc: Error fatal de pánico, cerrando... \n " ) ; RB_Close_The_Shop () ; /* Liberar todos los recursos */ exit ( 100 ) ; } /*******/

y el resultado

• Comparación de generadores de documentación

• Página principal de ROBODoc
• Repositorio Git de ROBODoc
• ROBODoc en SourceForge
• Generador de documentación para gambas2 y Gambas3: Interfaz de usuario para RoboDoc