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
|
Source: robodoc
Section: devel
Priority: optional
Maintainer: Ben Armstrong <synrg@sanctuary.nslug.ns.ca>
Standards-Version: 3.1.1
Package: robodoc
Architecture: any
Depends: ${shlibs:Depends}
Description: A 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, ASCII, AmigaGuide, LaTeX, or RTF. 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.
|