util/robodoc/README

   1 _______________________________________________________________________________
   2
   3
   4         THIS IS MODIFIED VERSION OF ROBODOC FOR SILC DISTRIBUTION
   5
   6                     Pekka Riikonen <priikone@silcnet.org>
   7
   8 _______________________________________________________________________________
   9
  10
  11 $Id$
  12
  13 ROBODoc  Version 3.2.3 May 2001.
  14
  15 ROBODoc is program documentation tool. The idea is to include for
  16 every function or procedure a standard header containing all
  17 sorts of information about the procedure or function.  ROBODoc
  18 extracts these headers from the source file and puts them in a
  19 separate autodocs-file.  ROBODoc thus allows you to include the
  20 program documentation in the source code and avoid having to
  21 maintain two separate documents.  Or as Petteri puts it: "robodoc
  22 is very useful - especially for programmers who don't like
  23 writing documents with Word or some other strange tool."
  24
  25 ROBODoc can format the headers in a number of different formats:
  26 HTML, ASCII, AmigaGuide, LaTeX, or RTF. In HTML mode it can
  27 generate cross links between headers. You can even include parts
  28 of your source code.
  29
  30 ROBODoc works with many programming languages: For instance C,
  31 Pascal, Shell Scripts, Assembler, COBOL, Occam, Postscript,
  32 Forth, Tcl/Tk, C++, Java -- basically any program in which you
  33 can use remarks/comments.
  34
  35   o For information on how to build and install see INSTALL
  36   o For information on how to use ROBODoc see Docs/robodoc.html.
  37   o Blank headers for various languages can be found in Headers/
  38   o For an example on how ROBODoc can be used
  39     (1) The ROBODoc source code in Source/
  40     (2) The C++ example in Examples/CPP/
  41   o For licence information see COPYING
  42   o For a change log see  Source/robodoc.c
  43
  44 Many people contributed to ROBODoc, to name a few:
  45
  46 o Petteri Kettunen <petterik@iki.fi>
  47   Bug fixes, FOLD, C features.
  48 o Bernd Koesling <KOESSI@CHESSY.aworld.de>
  49   Bug fixes, functional improvements, code cleanup.
  50 o Anthon Pang  <apang@mindlink.net>
  51   RTF support, Bug fixes.
  52 o Thomas Aglassinger <agi@sbox.tu-graz.ac.at>
  53   Fixes and cleanup of HTML-output
  54 o Stefan Kost kost@imn.htwk-leipzig.de
  55   Idea of the master index file and different header types.
  56
  57
  58 Questions, found a bug or a typo; send an email to <fslothouber@acm.org>
  59
  60 (c) 1994-2000  Frans Slothouber and Jacco van Weert
  61
  62
  63