home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 13 / CDA13.ISO / cdactual / demobin / share / program / C / AUTODOC.ZIP / AUTODOC.DOC < prev    next >
Encoding:
Text File  |  1988-06-05  |  2.7 KB  |  58 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                              Autodoc Documentation
  8.  
  9.      Autodoc is a program which aides in the documentation of C programs. 
  10.    It will read a C source code file looking for a special comment statement
  11.    ("/*%%*/") indicating where to start documentation. If it finds the start
  12.    documentation marker, it will proceed to create a modified copy of the
  13.    source file which contains some special comment blocks. One comment block
  14.    is placed at the beginning of the file listing all functions contained in
  15.    the file.  Additional comment blocks are placed at the beginning of each
  16.    function which lists the arguments required for that function.  Autodoc
  17.    can also be used to update the documentation for files in which functions
  18.    have been added.  In this case it will determine which funcions do not
  19.    have the special comment block (determined by comment blocks starting
  20.    with "/*+*") and add the special comment blocks for them.  In the update
  21.    mode, Autodoc will also add the name of the undocumented module to the
  22.    list at the beginning of the file.
  23.  
  24.      To use autodoc you must edit the source file to contain the start
  25.    documentation marker "/*%%*/" at a suitable point. Please note that the
  26.    marker should be placed after global function type declaration statements
  27.    and before the first function to be documented. Immediately before the
  28.    first function is generally the best spot. The command line invocation of
  29.    autodoc is:
  30.  
  31.       autodoc sourcefile [-option -option ...] where options are:
  32.  
  33.      -v   view undocumented modules found only do not document.
  34.      -aauthor   give authors name. If ommitted the program will 
  35.             prompt for the authors name.
  36.      -dMM/DD/YY  revision date. If ommitted the program will use
  37.           the current system date.
  38.      -f[filename] create or append to a function file declaration. 
  39.    this will cause the program to write an include file which contains all
  40.           of the function declarations in it. The default name for this
  41.            file is sourcefile.h.
  42.      -i    accept input from the keyboard describing new functions
  43.           yet to be written.
  44.      -nnewfilename  specifies the file to be created as a documented
  45.           copy of sourcefile. Default is "tempout".
  46.      sourcefile must be the complete  filename including .c  extension.
  47.  
  48.    Bugs:
  49.  
  50.       I'm sure that there are some so if you find 'em you fix 'em.
  51.  
  52.    Release Notice:
  53.        To show you what a nice guy I am I'm putting this in the public
  54.    domain.  If you make any zippy improvements I would appreciate a copy of
  55.    the source code changes. Send to :
  56.           Ed Alford
  57.           1577 Mendelssohn Drive
  58.           Westlake Ohio 44145