1 $d: README,v 1.5 2003/01/16 06:26:43 gumpu Exp $
3 ROBODoc Version 4.99.36 Jul 2007.
5 ROBODoc is program documentation tool. The idea is to include for
6 every function or procedure a standard header containing all
7 sorts of information about the procedure or function. ROBODoc
8 extracts these headers from the source file and puts them in a
9 separate autodocs-file. ROBODoc thus allows you to include the
10 program documentation in the source code and avoid having to
11 maintain two separate documents. Or as Petteri puts it: "robodoc
12 is very useful - especially for programmers who don't like
13 writing documents with Word or some other strange tool."
15 ROBODoc can format the headers in a number of different formats:
16 HTML, RTF, LaTeX, or XML DocBook. In HTML mode it can
17 generate cross links between headers. You can even include parts
20 ROBODoc works with many programming languages: For instance C,
21 Pascal, Shell Scripts, Assembler, COBOL, Occam, Postscript,
22 Forth, Tcl/Tk, C++, Java -- basically any program in which you
23 can use remarks/comments.
25 o For information on how to build and install see INSTALL
26 o For information on how to use ROBODoc see Docs/manual.html.
27 o Blank headers for various languages can be found in Headers/
28 o For an example on how ROBODoc can be used see
29 the ROBODoc source code in Source/
30 o For licence information see COPYING
31 o For a change log see Source/robodoc.c
33 Many people contributed to ROBODoc, to name a few:
35 o Petteri Kettunen <petterik -a-t- iki.fi>
36 Bug fixes, FOLD, C features.
37 o Bernd Koesling <KOESSI -a-t- CHESSY.aworld.de>
38 Bug fixes, functional improvements, code cleanup.
39 o Anthon Pang <apang -a-t- mindlink.net>
40 RTF support, Bug fixes.
41 o Thomas Aglassinger <agi -a-t- sbox.tu-graz.ac.at>
42 Fixes and cleanup of HTML-output
43 o Stefan Kost <kost -a-t- imn.htwk-leipzig.de>
44 Idea of the master index file and different header types.
46 Questions, found a bug or a typo; send an email to [rfsber -a-t- xs4all.nl]
48 (c) 1994-2005 Frans Slothouber, Petteri Kettunen, and Jacco van Weert