ROBODoc

From Wikipedia, the free encyclopedia

This article is about ROBODoc . For other uses, see ROBODoc (disambiguation).

ROBODoc
Developed by	Frans Slothouber
Latest release	4.99.36 / 13 Mar 2008
OS	Linux, Windows, Mac OS, Solaris
Genre	documentation generator
License	GNU General Public License
Website	ROBODoc Homepage

ROBODoc is a documentation tool similar to javadoc and licensed under the GPL. It is used to extract API documentation from source code. It can be used with any language that supports remarks and works by extracting specially formated headers. These are then reformatted into HTML, 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 scripts, Assembler, DCL, DB/C, Tcl/Tk, Forth, Lisp, COBOL, Occam, Basic, HTML, Clarion, and any other language that supports remarks.

1 History
2 Example
3 See also
4 External links

[edit] 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 produced ASCII output only. Jacco created a version that created output in Amigaguide format. This made it possible to create hyperlinks between the various documentation parts.

[edit] 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\n",cause) ;
     printf ("         %s\n", add_info) ;
     printf ("Robodoc: Panic Fatal error, closing down..\n") ;
     RB_Close_The_Shop () ; /* Free All Resources */
     exit(100) ;
   }
   
  /*******/

and the resulting output