- ROBODoc
Infobox_Software
name = ROBODoc
caption =
developer = Frans Slothouber
latest_release_version = 4.99.36
latest_release_date =13 Mar ,2008
operating_system =Linux , Windows,Mac OS , Solaris
genre =documentation generator
license =GNU General Public License
website = [http://www.xs4all.nl/~rfsber/Robo/robodoc.html ROBODoc Homepage]ROBODoc is a documentation tool similar to
javadoc and licensed under theGPL . It is used to extract API documentation fromsource code . It can be used with any language that supports remarks and works by extracting specially formated headers. These are then reformatted intoHTML ,DocBook , TROFF,ASCII ,LaTeX , PDF, or RTF.It can be used to document any programming artifact, such as: classes, functions, tests, makefile entries, etc.
ROBODoc works with C,
C++ ,Fortran ,Perl ,shell script s,Assembler ,DCL ,DB/C ,Tcl/Tk ,Forth , Lisp,COBOL ,Occam , Basic,HTML ,Clarion , and any other language that supports remarks.History
The first version of ROBODoc was written by Jacco van Weert in 1995. ROBODoc was inspired by the Autodocs program that was available on the
Amiga . Autodocs producedASCII output only. Jacco created a version that created output inAmigaguide format. This made it possible to create hyperlinks between the various documentation parts.Example
A typical ROBODoc header
/****f* Robodoc/RB_Panic [2.0d] * SYNOPSIS */ void RB_Panic (char* cause, char *add_info) /* * FUNCTION * Prints an error message. * Frees all resources used by robodoc. * Terminates program. * INPUTS * * cause - pointer to a string which describes the * cause of the error. * * add_info - pointer to a string with additional information. * SEE ALSO * RB_Close_The_Shop () * SOURCE */ { printf ("Robodoc: Error, %s ",cause) ; printf (" %s ", add_info) ; printf ("Robodoc: Panic Fatal error, closing down.. ") ; RB_Close_The_Shop () ; /* Free All Resources */ exit(100) ; } /*******/
and the resulting output
ee also
*
Comparison of documentation generators External links
* [http://www.xs4all.nl/~rfsber/Robo/robodoc.html ROBODoc Homepage]
* [http://sourceforge.net/projects/robodoc ROBODoc on SourceForge]
Wikimedia Foundation. 2010.
