home *** CD-ROM | disk | FTP | other *** search
/ Nebula 2 / Nebula Two.iso / SourceCode / MiscKit1.7.1 / MiscKit / Examples / AutoDoc / CHANGES next >
Encoding:
Text File  |  1995-11-02  |  6.0 KB  |  166 lines
  1. Thu Nov  2 13:03:00 1995 - autodoc version 1.8.4 release notes: CHANGES
  2.  
  3.  CHANGES SUMMARY
  4.  
  5.     Protocols can be documented.
  6.     The protocols conformed to by a class, category or protocol are
  7.         documented.
  8.     Functions, typedefs, defines, macros, and globals are documented 
  9.     Command line switches can be specified with full names or short names.
  10.     The copyright owner string can be set as an environment variable 
  11.         AD_COPYRIGHT. (see setenv for csh, or export for zsh)
  12.         
  13.     (internally)
  14.     Autodoc has been divided into modules to encapsulate behaviors and data
  15.     All RTF specific output is provided by GenerateRTF.pm
  16.  
  17.  
  18.  CHANGES LOG: (autodoc)
  19.  
  20.     RELEASE 1.8.4 - REVISION 1.5 (1995/10/20  22:10:41  aswift)
  21. Completed checkin using DevMan Logs
  22.   
  23.     RELEASE 1.8.4 - REVISION 1.4 (1995/10/20  16:45:28  aswift)
  24. Continuing to try DevMan Log history
  25.   
  26.     RELEASE 1.8.4
  27. - fixed "up to date documentation" testing 
  28. - added missing small newlines between the methods and their documentation
  29. - moved tab locations in the Defined Types stuff to improve doc apperance
  30. - long method lines are now broken into multiple lines
  31. - added new paragraph styles to the GenerateRTF module
  32.   
  33.     RELEASE 1.8.3
  34. - completely documented GenerateRTF.pm Autodoc module
  35. - abstracted DumpDocs to remove rtf dependancies
  36. - fixed case insensitive argument parsing to differentiate -D from -d (bbum)
  37. - cleaned up usage of 'require' and 'use' to remove redundancy (bbum)
  38. - added support for documenting what protocols an object conforms to.
  39. - added support for documenting protocols. (Craig Kelley)
  40.   
  41.     RELEASE 1.8.2
  42. - added version control to the support modules, and their version is now
  43.   reported when the -version option is used
  44. - removed some warning messages in file_expandpath
  45. - fixed bug preventing doc creation with .[hm] files with no object def.
  46. - fixed resource naming when files are specified with no project dir
  47. - fixed boldifying values of typedef-type structures
  48. - allowed multiple levels of indention to follow curly braces in typedef's
  49.   
  50.     RELEASE 1.8.1 - MiscKit Release 1.6.1
  51. - fixed documentation extraction failure detection
  52. - added support for AD_PMLIBDIR to specify perl module lib directory
  53. - added more log debugging to Autodoc .pm files
  54. - moved LogDebug::Log.pm into Autodoc::LogDebug.pm
  55. - moved FileSupport::Misc.pm into Autodoc::FileSupport.pm
  56.   
  57.     RELEASE 1.8
  58. - added -nosingles option to exclude unpaired '.h' and '.m' files from docs
  59. - added support for functions, typedefs, defines, macros, and globals
  60. - moved all autodoc doc creation into Autodoc::DumpDocs
  61. - moved all autodoc source reading into Autodoc::ReadSource
  62. - moved autodoc comment parsing into Autodoc::ParseComment
  63. - moved source file scanning code into Autodoc::ScanFile module
  64. - added timestamping capability for documentation
  65. - can now set copyright string with environment var: AD_COPYRIGHT
  66. - moved debug logging into LogDebug::Log
  67. - moved filepath expansion into FileSupport::Misc
  68.   
  69.     RELEASE 1.7 - contributions by b.bum
  70. - added support for GetOpts::Long package; GetOpts::Long can deal w/single 
  71.   character argnames as long as they aren't ambiguous.
  72. - removed all warnings produced by perl -w
  73. - modified scan_line to discard stars from the beginning of ADC lines
  74. - added -help option;  shows help and exits.
  75. - made a Source directory and moved code files into (as per the README)
  76. - look for '## bbum';  i fixed a bunch of a stuff that produced
  77.   warnings when the rtf documentation did not yet exist.
  78. - fixed -force so that it actually works.
  79. - added NULL to list of bold words
  80. - any instance variable on a line w/the word "INTERNAL" will be skipped.
  81. - fixed method parameter matching to allow whitespace between the : and arg.
  82.   (Kim Shrier)
  83. - fixed argument italicising in method docs to parse out whitespace between 
  84.   the : and arg (Kim Shrier)
  85.   
  86.     RELEASE 1.6
  87. - added \ escaping for % and # characters to force display 
  88.   
  89.     RELEASE 1.5.1
  90. - fixed the "Category Description" bug.  Was putting out "Class Description"
  91.   (Todd Nathan)
  92.   
  93.     RELEASE 1.5 - MiscKit Release
  94. - added option to force overwriting up-to-date documentation files
  95. - added time check for source and doc files to prevent unnecessary work
  96. - added support for copying .rtf and .rtfd files to the doc dir
  97. - added support for specifying a copyright owner on the command line
  98. - fixed ivar parsing so it doesn't skip the line with the starting brace
  99.   
  100.     RELEASE 1.4
  101. - added minimal category support.
  102. - changed filename to autodoc (from AutoDoc)
  103. - added support for relative path naming for documentation and project dirs.
  104. - fixed bug which aborted doc creation if no newline was found on @end line
  105.   
  106.     RELEASE 1.3
  107. - Added minimal support for lists of items via _{xxx desc} format
  108. - Fixed matching problems at beginning and ends of text strings
  109. - Added "id" to the list of bold words.
  110. - Filtered out @public/@private/@protected modifiers in ivars.
  111. - Fixed incorrect struct detection in ivars with curly braces in a following
  112.   AutoDoc comment.
  113.   
  114.     RELEASE 1.2
  115. - Started tracking changes
  116.   
  117.  
  118.  CHANGES LOG: (ReadSource.pm)
  119.  
  120.     RELEASE 1.8.4 - REVISION 1.2 (1995/10/20  22:16:28  aswift)
  121. Added DevMan style changes Log support
  122.     
  123.  
  124.  CHANGES LOG: (DumpDocs.pm)
  125.  
  126.     RELEASE 1.8.4 - REVISION 1.3 (1995/10/20  22:16:25  aswift)
  127. Added DevMan style changes Log support
  128.     
  129.  
  130.  CHANGES LOG: (ScanFile.pm)
  131.  
  132.     RELEASE 1.8.4 - REVISION 1.2 (1995/10/20  22:16:29  aswift)
  133. Added DevMan style changes Log support
  134.     
  135.  
  136.  CHANGES LOG: (LogDebug.pm)
  137.  
  138.     RELEASE 1.8.4 - REVISION 1.2 (1995/10/20  22:16:27  aswift)
  139. Added DevMan style changes Log support
  140.     
  141.  
  142.  CHANGES LOG: (GenerateRTF.pm)
  143.  
  144.     RELEASE 1.8.4 - REVISION 1.3 (1995/10/20  22:16:26  aswift)
  145. Added DevMan style changes Log support
  146.     
  147.  
  148.  CHANGES LOG: (ParseComments.pm)
  149.  
  150.     RELEASE 1.8.4 - REVISION 1.2 (1995/10/20  22:16:28  aswift)
  151. Added DevMan style changes Log support
  152.     
  153.  
  154.  CHANGES LOG: (FileSupport.pm)
  155.  
  156.     RELEASE 1.8.4 - REVISION 1.3 (1995/10/20  22:16:26  aswift)
  157. Added DevMan style changes Log support
  158.     
  159.  
  160.  THANKS!!!
  161.  
  162. BIG thanks to Bill Bumgarner <bbum@friday.com>, Todd Nathan <todd@icebox.com>, Kim Shrier <kim@media.com>, and Craig Kelley <ckelley@capaccess.org> for their contributions.
  163.  
  164. - adam
  165.  
  166.