Improvements on Method comments.

[Montana]

Hi all,

I've listed all my changes, and before and afters in this Hulu repo entitled GrannySmith.

Some of the first things I did were:

• Added parameter and return type documentation for initialization methods.

• Provided example usage for the fancyTextViewWithFrame:markupText: method.

Before:

/// The GSFancyText object for this view
@property (nonatomic, retain) GSFancyText* fancyText;

/// The content height of the fancyText object.
@property (nonatomic, assign, readonly) CGFloat contentHeight;

/** If matchFrameHeightToContent is set to YES, the view frame height will be set to match the content height
 * every time updateDisplay method is called.
 *
 * If it's set to NO, every time we call updateDisplay, only the new width will be used to affect the line height.
 */
@property (nonatomic, assign) BOOL matchFrameHeightToContent;


/** If it is set to YES, the view frame width will be set to match the content width (if the actually content is narrower than assigned width)
 * every time updateDisplay method is called.
 */
@property (nonatomic, assign) BOOL matchFrameWidthToContent;

After:

/// The GSFancyText object for this view.
@property (nonatomic, retain) GSFancyText *fancyText;

/// The content height of the fancyText object.
@property (nonatomic, assign, readonly) CGFloat contentHeight;

/** Determines whether the view frame height should match the content height.
 *
 * If set to YES, the view frame height will be set to match the content height
 * every time the updateDisplay method is called.
 *
 * If set to NO, the new width will be used to affect the line height when updateDisplay is called.
 */
@property (nonatomic, assign) BOOL matchFrameHeightToContent;

/** Determines whether the view frame width should match the content width.
 *
 * If set to YES, the view frame width will be set to match the content width (if the actual content is narrower than the assigned width)
 * every time the updateDisplay method is called.
 */
@property (nonatomic, assign) BOOL matchFrameWidthToContent;

• Added spaces between the type and the asterisk in pointer declarations (e.g., GSFancyText *fancyText_ instead of GSFancyText* fancyText_).

• Ensured consistent use of indentation and spacing throughout the file.

Cheers,
Michael Mendy