ROBODoc - Extract documentation from source code.

robodoc --src <source> --doc <destination> [options]

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

--ascii

Generate documentation in ASCII format.

--doc

Define the documentation directory or documentation file. A directory should start with a '/' or a './' and should not include any '..'.

--html

Generate documentation in HTML format.

--index

Create an additional master index file.

--latex

Generate documentation in LaTeX format.

--multidoc

Store all documentation in seperate files.

--rtf

Generate documentation in RTF format.

--singledoc

Store all documentation in a single file.

--src

Define the source directory or source file. A directory should start with a '/' or a './' and should not include any '..'.

--tell

ROBODoc tells you about every step it takes.

--version

Print version information and exit.

robodoc --src ./ --doc myproject --singledoc --html

Creates a document called myproject.html from all source files in the current directory.

robodoc --src ./myproject/ --doc ./myprojectdoc --multidoc --html --index

Creates seperate documents for all the source files found in the directory ./myproject they are stored in the directory ./myprojectdoc. A master index file called ./myprojectdoc/masterindex.html is also created. This provides links to all the individual files.

Example headers

/usr/share/doc/robodoc/Examples
/usr/share/doc/robodoc/Headers

Copyright © 1994-2003 Frans Slothouber, Petteri Kettunen, and Jacco van Weert.

This is free software; see the source for copying conditions. There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

Frans Slothouber, Jacco van Weert, Petteri Kettunen, Bernd Koesling, Thomas Aglassinger, Anthon Pang, Stefan Kost, David Druffner, Sasha Vasko, Nathan Prewitt and Dennis Stampfer.

The documentation in HTML format that comes with ROBODoc. Latest version can be found from http://www.xs4all.nl/~rfsber/Robo/ or from http://sourceforge.net/projects/robodoc/.

robohdrs(1)