Projects / ROBODoc

ROBODoc

ROBODoc is an API documentation tool. It extracts specially-formated comment headers from a source file and puts them in a separate file. ROBODoc allows you to include the program documentation in the source code and avoid having to maintain two separate documents. ROBODoc can format the documentation in HTML, LaTeX, RTF, XML DocBook, or ASCII format. It is even possible to include parts of the source code. It works with Assembler, C, C++, Java, Perl, LISP, Occam, Tcl/Tk, Pascal, Fortran, shell scripts, HTML, and COBOL; basically any language that supports comments.

Tags
Licenses
Operating Systems
Implementation

Recent releases

  •  06 Feb 2011 21:45

    Release Notes: This release fixes a segmentation fault with source items, and transitions from sourceforge to github.

    •  13 May 2010 21:36

      Release Notes: Various bugs were fixed. Changes were made to troff_generator.c to make it compile again under Cygwin. A make install no longer installs a roboboc.rc but a robodoc_example.rc. ROBODoc now only looks in 'sane' places for a robodoc.rc file.

      •  27 Jun 2007 20:12

        Release Notes: The documentation was extended. A bug in the parsing of the robodoc.rc file was fixed. The option --header_breaks was added, which allows ROBODoc to insert line breaks after every specified number of header names to improve readability.

        •  30 May 2007 16:31

          Release Notes: The option --no_subdirectories was added to allow users to generate documentation in a single directory instead of a directory tree. The parsing of headers was made more robust. The order in which items are to appear in the documentation can now be specified in the robodoc.rc file.

          •  09 Feb 2007 00:38

            Release Notes: The main focus of this release is configurability. This version allows you to fine-tune the formatting of the items and the syntax colouring of source code. It is now possible to specify the separator for the header names. For people that want to include the generated documentation in other documents, it is now possible to specify the level of the first documentation section.

            Recent comments

            09 Jul 2000 01:12 richardrusso

            usable
            I fell in love with javadoc, but I can't solve all of my problems with java. I like the fact that I can use this in documenting C library code. ROBODoc supports an impressively wide range of input languages and output formats. I looked at a few alternatives, but they don't seem to have ROBODoc's flexibility.

            Screenshot

            Project Spotlight

            OpenStack4j

            A Fluent OpenStack client API for Java.

            Screenshot

            Project Spotlight

            TurnKey TWiki Appliance

            A TWiki appliance that is easy to use and lightweight.