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 . Se puede utilizar con cualquier idioma que admita comentarios y funciona extrayendo encabezados con formato especial. Luego se reformatean en HTML , DocBook , TROFF , ASCII , LaTeX , PDF o RTF .
Desarrollador (es) | Frans Slothouber |
---|---|
Versión inicial | 1994 |
Lanzamiento estable | 4.99.43 / 26 de abril de 2015 |
Sistema operativo | Linux , Windows , Mac OS , Solaris |
Tipo | Generador de documentación |
Licencia | Licencia pública general GNU |
Sitio web | Página de inicio de ROBODoc |
Se puede utilizar para documentar cualquier artefacto de programación, como: clases, funciones, pruebas, entradas de archivos MAKE, 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. [ cita requerida ]
Historia
La primera versión de ROBODoc fue escrita por Jacco van Weert en 1995. ROBODoc se inspiró en el programa Autodocs que estaba disponible en Amiga . Autodocs produjo solo salida ASCII . Jacco creó una versión que creaba resultados en formato Amigaguide . Esto hizo posible crear hipervínculos entre las distintas partes de la documentación.
Ejemplo
Un cabezal ROBODoc típico
/ **** 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. * Termina el programa. * ENTRADAS * * causa - puntero a una cadena que describe la * causa del error. * * add_info: puntero a una cadena con información adicional. * VEA TAMBIÉN * RB_Close_The_Shop () * FUENTE * / { printf ( "Robodoc: Error,% s \ n " , causa ) ; 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 la salida resultante
Ver también
enlaces externos
- Página de inicio de ROBODoc
- Repositorio ROBODoc git
- ROBODoc en SourceForge
- Generador de documentación para gambas2 y Gambas3: Front-End para RoboDoc