Editing ROBODoc

{{About|the automated documentation tool|the ''motion picture'' written by Doug and Scott Gordon MD and distributed by National Lampoon|RoboDoc|other uses|Robodoc (disambiguation){{!}}Robodoc}}
{{Infobox Software
| name                   = ROBODoc
| logo                   = 
| caption                = 
| screenshot             = 
| developer              = Frans Slothouber
| released = {{release date|1994}}
| latest release version = 4.99.44
| latest release date    = {{release date|2021|01|29}}
| operating system       = [[Linux]], [[Microsoft Windows|Windows]], [[Mac OS]], [[Solaris (operating system)|Solaris]]
| genre                  = [[Documentation generator]]
| license                = [[GNU General Public License]]
| repo                   = {{URL|https://github.com/gumpu/ROBODoc}}
| programming language   = [[C (programming language)|C]]
| website                = [http://rfsber.home.xs4all.nl/Robo/index.html  ROBODoc Homepage]
}}
'''ROBODoc''' is a documentation tool similar to [[Javadoc]] and licensed under the [[GPL]]. It is used to extract [[application programming interface|API]] documentation from [[source code]]. It can be used with any language that supports comments and works by extracting specially formatted headers.  These are then reformatted into [[HTML]], [[DocBook]], [[Troff|TROFF]], [[ASCII]], [[LaTeX]], [[Portable Document Format|PDF]], or [[Rich Text Format|RTF]].

It can be used to document any programming artifact, such as: classes, functions, tests, makefile entries, etc.

ROBODoc works with [[C (programming language)|C]], [[C++]], [[Fortran]], [[Perl]], [[shell script]]s, [[Assembly language|Assembler]], [[DIGITAL Command Language|DCL]], [[DB/C]], [[Tcl/Tk]], [[Forth (programming language)|Forth]], [[Lisp (programming language)|Lisp]], [[COBOL]], [[Occam programming language|Occam]], [[BASIC|Basic]], [[HTML]], [[Clarion (programming language)|Clarion]], and any other language that supports comments.{{fact|date=April 2013}}

==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.

==Example==

A typical ROBODoc header
<syntaxhighlight lang="c">
  /****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) ;
    }
    
   /*******/
</syntaxhighlight>
and the resulting output

[[Image:Robodoc example small.png]]

==See also==
{{Portal|Free and open-source software}}
*[[Comparison of documentation generators]]

==External links==
*[https://rfsber.home.xs4all.nl/Robo/ ROBODoc Homepage]
*[https://github.com/gumpu/ROBODoc ROBODoc git repository]
*[http://sourceforge.net/projects/robodoc ROBODoc on SourceForge]
*[http://jsbsan.blogspot.com/2011/11/generador-de-documentacion-para-gambas2.html Documentation generator for gambas2 and Gambas3: Front-End for RoboDoc]


[[Category:Free documentation generators]]
[[Category:Source code documentation formats]]
[[Category:Software using the GNU General Public License]]


{{Programming-software-stub}}