AutoCommentor

Superclass

Object

Subclasses

ImageCommentor, HtmlCommentor

Subclass Responsibilities

#gt, #preformattedString:, #typeString:, #var:type:, #tab, #email:,

#end, #classString:, #fontBegin, #section:withList:, #begin,

#defaultContact, #heading, #createComment, #url:, #fontEnd,

#genFormattedExistingSection, #lt, #cr, #genUnformattedExistingSection,

#image:

Referenced By

AutoCommentorDialog, ClassCommentTool

Steps for adding a new regular expression
1) Create *RegExp method in AutoCommentor class>regular expressions
	which returns the regular expression string.
2) Create *Parser: method in AutoCommentor>parsers
3) Create string generation method in the 'string - parsed substr' protocol of
	AutoCommentor, ImageCommentor, and HtmlCommentor
4) Add entry for Matchers initialization in AutoCommentor class>>matchersSpec
5) Add entry to AutoCommentor>>findInExistingComment.  If new regular expression overlaps
with 
	another regular expression, make sure they are correctly ordered.

For an example of the results loof at the top of the Cat comment hierarchy: 
	http://cat.ncsa.uiuc.edu/~yoder/fmdocs/comments/

Instance Variables
commentClass   <Class>	[description]
comment   <String>	[description]
classVariable   <Boolean>	[description]
instVariable   <Boolean>	[description]
params   <AutoCommentorParameters>	[description]
isSearched   <Boolean>	[description]
commentStream   <Stream>	[description]
parsedSubstrings   <SortedCollection of: ParsedSubstringSpec>	[description]

Class Variables
Contact   <String>	[email address]
Matchers   <Dictionary of: RxMatcher | UnixRegExpression>	[description]
References   <Dictionary of: Set | Association>	[description]
Destination   <String>	[directory name]

Original Design and Ideas by Jeff Barcalow (barcalow@uiuc.edu) and Joe Yoder (yoder@uiuc.edu)
Developed by Jeff Barcalow (barcalow@uiuc.edu) with Minor Coding by Joe Yoder (yoder@uiuc.edu)