ftp.nice.ch/pub/next/developer/resources/classes/misckit/MiscKit.1.10.0.s.gnutar.gz#/MiscKit/Examples/AutoDoc

CHANGES
 
Examples/
 
Guide/
 
INSTALL
 
Notes/
 
README
 
bin/
 
etc/
 
htdocs/
 
lib/
 

README

Thu Nov  2 13:03:00 1995 - autodoc version 1.8.4 release notes: README


 DESCRIPTION

Autodoc is a FREE utility that generates NEXTSTEP-style Rich Text Formatted documentation for Objective-C classes, categories and protocols by extracting comments imbedded in the source code files. Autodoc will also produce documentation for functions, definitions, macros, typedef's and global variables.

Autodoc is available for free. The latest release of Autodoc, v1.8.4, is available at ftp.friday.com.


 BACKGROUND

Autodoc is a perl script originally developed by Adam Swift <aswift@friday.com> at Information Technology Solutions, it is now being maintained by Adam Swift and Bill Bumgarner for Friday Software and Consulting.  Autodoc has been donated free of charge to the Public Domain. 


 SYSTEM REQUIREMENTS

In order to run Autodoc, you need to have perl v5.001 installed on your system. Perl is freely available from a number of places, but the most up to date version (precompiled tri-fat) is available from ftp.thoughtport.com thanks to Bill Bumgarner.


 INSTALLATION

See the INSTALL file for information on installing and running Autodoc.  In general, previous Autodoc execution commands should work as they did before; however, the installation process is a little bit more involved because Autodoc has been split into modules.


 RELEASE NOTES

See the CHANGES file for a summary of improvements since the last release.  Biggest changes: protocols, functions, constants, typedefs, globals, and macros are now documented.


 OTHER STUFF

Mailing List: There is a low bandwidth autodoc mailing list: autodoc@friday.com.  To subscribe, send an empty message with the subject line, "subscribe", to <autodoc-request@friday.com>.


Enjoy!

- adam

These are the contents of the former NiCE NeXT User Group NeXTSTEP/OpenStep software archive, currently hosted by Netfuture.ch.