GITActor Class Reference

#import <GITActor.h>

List of all members.

Public Member Functions

(id) - initWithName:
(id) - initWithName:andEmail:

Properties

NSString * name
 Name of the actor.
NSString * email
 Email address of the actor.


Detailed Description

A git user. The actor class encapsulates the name and email pair for a user of git. The actor can be thought of as similar to the
 git config user.name
 git config user.email
configuration settings.

See also:
GITCommit

GITTag

For internal use only.

Presently only used by Tag and Commit objects.


Member Function Documentation

- (id) initWithName: (NSString*)  theName  

Creates and returns an actor object with the provided name. The created actor object will have an email address of nil.

Parameters:
theName The name of the actor to create.
Returns:
An actor object with the provided name.

- (id) initWithName: (NSString*)  theName
andEmail: (NSString*)  theEmail 

Creates and returns an actor object with the provided name and email.

Parameters:
theName The name of the actor.
theEmail The email address of the actor.
Returns:
An actor object with the provided name and email.


Property Documentation

- (NSString *) email [read, copy]

Email address of the actor.

- (NSString *) name [read, copy]

Name of the actor.


The documentation for this class was generated from the following files:

Generated on Mon Dec 8 22:57:08 2008 for CocoaGit by  doxygen 1.5.7