home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / programming / utilities / gadoc.lha / gadoc.c / gadoc.readme < prev    next >
Encoding:
Text File  |  1995-03-02  |  1.4 KB  |  47 lines
  1. Short:    GAdoc v1.1, Extract autodocs and generate TeXinfo file, incl. xref
  2. Uploader: leibrock@fsinfo.cs.uni-sb.de (Gerhard Leibrock)
  3. Author:   leibrock@fsinfo.cs.uni-sb.de (Gerhard Leibrock)
  4. Type:     dev/misc
  5.  
  6. GAdoc (Get Auto DOC) is a program which extracts autodoc-style comments
  7. out of any file and generates a two part TeXinfo file out of it.
  8.  
  9.  
  10.     THIS PROGRAM NEEDS TEX OR MAKEINFO TO BE OF ANY USE!
  11.  
  12.  
  13. Warning:
  14.     This program is missing some of the features that can be
  15.     found in the autodoc program from Commodore:
  16.  
  17.     * Lines *strictly* limited to 80 chars/line
  18.     * No word wrapping, if line is longer than 80 chars
  19.     * Ignores first character of each line
  20.     * Only generates texinfo files, nothing else.
  21.  
  22. Features:
  23.     * Can extract internal autodocs
  24.     * Supports main program header, as introduced with ROBODdoc from
  25.       weertj@euronet.nl, which didn't work very well on my Amiga
  26.       (So I wrote my own one).
  27.     * Supports xrefs to other files and within the autodoc itself.
  28.  
  29. Compiled with gcc263; runs under NetBSD, Amiga OS, Solaris.
  30.  
  31. (Will NOT run under SM-DOS, because of the filename extensions used :)
  32.  
  33. GAdoc v1.1 is written by Gerhard Leibrock
  34.  
  35.     Email:    leibrock@fsinfo.cs.uni-sb.de
  36.         (fach5@cipsol.cs.uni-sb.de)
  37.  
  38.     Smail:
  39.         Gerhard Leibrock
  40.         Neuhaeuselerstr. 12
  41.         66459 Kirkel, Germany
  42.  
  43. This is an UPDATE of version 1.0. The source was buggy, because I edited
  44. it, but I never did compile it again... Now it works, as it is expected to.
  45.  
  46.  
  47.