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