GBCommentArgument Class Reference

Inherits from NSObject
Declared in GBCommentArgument.h<br />GBCommentArgument.m

Overview

Describes an argument of a GBComment .

An argument is a named argument such as parameter or exception. It contains the argument (parameter or exception) name as argumentName and corresponding description in the form of GBCommentParagraph as argumentDescription .

Tasks

Initialization & disposal

Values

Other Methods

Class Methods

argument

Returns a new autoreleased argument with no name and description.

+ (id)argument

Discussion

Returns a new autoreleased argument with no name and description.

Declared In

GBCommentArgument.h
GBCommentArgument.m

argumentWithName:description:

Returns a new autoreleased argument with the given name and description.

+ (id)argumentWithName:(NSString *)name description:(GBCommentParagraph *)description

Parameters

name
The name of the argument.
description
Description of the argument.

Return Value

Returns initialized instance.

Discussion

Returns a new autoreleased argument with the given name and description.

Sending this method is equivalent to: 

 GBCommentArgument *argument = [[[GBCommentArgument alloc] init] autorelease];
argument.argumentName = name;
argument.argumentDescription = description;

Exceptions

NSException
Thrown if name is nil or empty string or description is nil .

Declared In

GBCommentArgument.h
GBCommentArgument.m

Instance Methods

debugDescription

description

Properties

argumentDescription

Description of the argument as `GBCommentParagraph.

@property (retain) GBCommentParagraph *argumentDescription

Discussion

Description of the argument as `GBCommentParagraph.

See Also

Declared In

GBCommentArgument.h

argumentName

The name of the argument.

@property (copy) NSString *argumentName

Discussion

The name of the argument.

See Also

Declared In

GBCommentArgument.h