ROBODoc(1)

NAME
ROBODoc - Extract documentation from source code.

SYNOPSIS
robodoc source-file documentation-file [options]

DESCRIPTION
ROBODoc extracts specially formated documentation from the source code. It allows you to maintain a program and its documentation in a single file.

OPTIONS

ASCII
    Generate documentation in ASCII format.

-c  Show warranty and copyright statement.

C   Use ANSI C grammar in source items (experimental, HTML only).

FOLD
    Enable folding if HTML output is selected (experimental).

GENXREF xreffile
    Generate a xreffile.

GUIDE
    Generate documentation in Amiga Guide format.

HTML
    Generate documentation in HTML format.

INDEX
    Create a master index file. In this case call robodoc as robodoc <xrefsfile> <master index file> INDEX

INTERNAL
    Also include headers that are marked internal.

INTERNALONLY
    Only extract the headers that are marked internal (that start with ****i*).

NOSOURCE
    Do not include the source items in the documentation.

LATEX
    Generate documentation in LaTeX format.

RTF Generate documentation in RTF format.

SINGLEDOC
    Do not create a document header and footer when creating documentation in LaTeX format. This allows you to include the generated documents into big document or master index file.

SORT
    Sort the headers alphabetically.

TABSIZE <n>
    Convert each tab into n spaces.

TITLE
    Sets the title that is used for the master index file.

TOC Generate a table of contents. Is only useful when you select ASCII as output mode. With all other output modes the Table of contents is generated anyway.

-v  Verbose mode, robodoc tells what it is doing.

XREF <xrefsfile>
    Use the all xref files listed in the file xrefsfile to make cross links between documents. The following abbreviations are also allowed: -s SORT, -t TOC, -x XREF, -g GENXREF, -i INTERNAL, -io INTERNALONLY, -ts TABSIZE.

ITEM NAMES SUPPORTED

NAME
    Item's name followed by --, then a short description.

COPYRIGHT
    Who own the copyright.

SYNOPSIS, USAGE
    How to use it.

FUNCTION, DESCRIPTION, PURPOSE
    What does it do.

AUTHOR
    Who wrote it.

CREATION DATE
    When did the work start.

MODIFICATION HISTORY, HISTORY
    Who has done which changes and when.

INPUTS, ARGUMENTS, OPTIONS, PARAMETERS, SWITCHES
    What can we feed into it.

OUTPUT, SIDE EFFECTS
    What output is made.

RESULT, RETURN VALUE
    What do we get returned.

EXAMPLE
    A clear example of the items use.

NOTES
    Any annotations.

DIAGNOSTICS
    Diagnostical output.

WARNINGS, ERRORS
    Warning & error-messages.

BUGS
    Known bugs.

TODO, IDEAS
    What to implement next & ideas.

PORTABILITY
    Where does it come from, where will it work.

SEE ALSO
    References to other functions, man pages, other documentation.

METHODS, NEW METHODS
    OOP methods.

ATTRIBUTES, NEW ATTRIBUTES
    OOP attributes, could also be used for structures.

TAGS
    Tagitem description.

COMMANDS
    Command description.

DERIVED FROM
    OOP super class.

DERIVED BY
    OOP sub class.

USES, CHILDREN
    What modules are used by this one.

USED BY, PARENTS
    Which modules use this one.

SOURCE
    Source code inclusion.

HEADER TYPES SUPPORTED

h   Header that describes the project.

f   Header for a function.

s   Header for a structure.

c   Header for a class.

m   Header for a method.

v   Header for a variable

d   Header for a constant (from define).

i   Internal header.

*   Generic header, for everything else.

EXAMPLES
A simple example, you have one tcl source file and want to extract the documentation.
    robodoc wopr.tcl wopr.tcl.html HTML SORT
Assume you have a program divided in two source files, gluify.c and gluify.h. To generate the documentation for this program, complete with cross links, you would use:
    echo "gluify.c.xref" > gluify.xrefs
    echo "gluify.h.xref" >> gluify.xrefs
    robodoc gluify.c gluify.c.html HTML GENXREF gluify.c.xref
    robodoc gluify.h gluify.h.html HTML GENXREF gluify.h.xref
    robodoc gluify.c gluify.c.html HTML XREF gluify.xrefs
    robodoc gluify.h gluify.h.html HTML XREF gluify.xrefs

SEE ALSO
The documentation in HTML format that comes with ROBODoc. Latest version can be found on http://www.xs4all.nl/~rfsber/Robo/ or on http://freshmeat.net/