Skip to content

Commit

Permalink
Some more pragma marks
Browse files Browse the repository at this point in the history
  • Loading branch information
benlangfeld committed Oct 15, 2010
1 parent 886bce6 commit a7fb546
Show file tree
Hide file tree
Showing 5 changed files with 37 additions and 13 deletions.
14 changes: 10 additions & 4 deletions TNStropheConnection.j
Expand Up @@ -89,6 +89,9 @@
id _connection;
}

#pragma mark -
#pragma mark Class methods

/*! instanciate a TNStropheConnection object
@param aService a url of a bosh service (MUST be complete url with http://)
Expand Down Expand Up @@ -118,6 +121,9 @@
return [[TNStropheConnection alloc] initWithService:aService JID:aJID resource:aResource password:aPassword];
}

#pragma mark -
#pragma mark Initialization

/*! initialize the TNStropheConnection
@param aService a url of a bosh service (MUST be complete url with http://)
Expand Down Expand Up @@ -186,7 +192,7 @@


#pragma mark -
#pragma mark TNStropheConnection Connection
#pragma mark Connection

- (void)addNamespaceWithName:(CPString)aName value:(CPString)aValue
{
Expand Down Expand Up @@ -290,7 +296,7 @@


#pragma mark -
#pragma mark TNStropheConnection Features
#pragma mark Features

- (void)addFeature:(CPString)aFeatureNamespace
{
Expand Down Expand Up @@ -342,7 +348,7 @@


#pragma mark -
#pragma mark TNStropheConnection Sending
#pragma mark Sending

/*! send a TNStropheStanza object
@param aStanza: the stanza to send
Expand Down Expand Up @@ -393,7 +399,7 @@


#pragma mark -
#pragma mark TNStropheConnection Handlers
#pragma mark Handlers

/*! allows to register a selector for beeing fired on XMPP events, according to the content of a dictionnary parameter.
The dictionnary should contains zero to many of the followings :
Expand Down
6 changes: 6 additions & 0 deletions TNStropheContact.j
Expand Up @@ -56,6 +56,9 @@
CPImage _statusReminder;
}

#pragma mark -
#pragma mark Class methods

/*! create a contact using a given connection, JID and group
@param aConnection TNStropheConnection to use
@param aJID the JID of the contact
Expand All @@ -68,6 +71,9 @@
return [[TNStropheContact alloc] initWithConnection:aConnection JID:aJID groupName:aGroupName];
}

#pragma mark -
#pragma mark Initialization

/*! init a TNStropheContact with a given connection
@param aConnection TNStropheConnection to use
Expand Down
10 changes: 6 additions & 4 deletions TNStropheRoster.j
Expand Up @@ -24,10 +24,6 @@
@import "TNStropheContact.j"
@import "TNStropheGlobals.j"


#pragma mark -
#pragma mark TNStropheRoster

/*! @ingroup strophecappuccino
this is an implementation of a basic XMPP Roster
*/
Expand All @@ -41,11 +37,17 @@
TNStropheGroup _defaultGroup;
}

#pragma mark -
#pragma mark Class methods

+ (TNStropheRoster)rosterWithConnection:(TNStropheConnection)aConnection
{
return [[TNStropheRoster alloc] initWithConnection:aConnection];
}

#pragma mark -
#pragma mark Initialization

/*! initialize a roster with a valid TNStropheConnection
@return initialized instance of TNStropheRoster
Expand Down
11 changes: 6 additions & 5 deletions TNStropheStanza.j
Expand Up @@ -17,18 +17,16 @@
*/

@import <Foundation/Foundation.j>

@import "TNXMLNode.j"


#pragma mark -
#pragma mark TNStropheStanza

/*! @ingroup strophecappuccino
this is an implementation of a basic XMPP Stanza
*/
@implementation TNStropheStanza: TNXMLNode

#pragma mark -
#pragma mark Class methods

/*! instanciate a TNStropheStanza
@param aName the root name
@param attributes CPDictionary of attributes
Expand Down Expand Up @@ -108,6 +106,9 @@
return [[TNStropheStanza alloc] initWithNode:aStanza];
}

#pragma mark -
#pragma mark Attributes

/*! get the from field of the stanza
@return from field of stanza
*/
Expand Down
9 changes: 9 additions & 0 deletions TNXMLNode.j
Expand Up @@ -27,6 +27,9 @@
XMLElement _xmlNode @accessors(readonly, getter=xmlNode);
}

#pragma mark -
#pragma mark Class methods

/*! create an instance of a TNXMLNode from a pure javascript Node
@param aNode a pure Javascript DOM Element
@return an instance of TNXMLNode initialized with aNode
Expand Down Expand Up @@ -55,6 +58,9 @@
return [[TNXMLNode alloc] initWithName:aName andAttributes:someAttributes];
}

#pragma mark -
#pragma mark Initialization

/*! initialize an instance of a TNXMLNode from a pure javascript Node
@param aNode a pure Javascript DOM Element
@return an instance of TNXMLNode initialized with aNode
Expand Down Expand Up @@ -93,6 +99,9 @@
return self;
}

#pragma mark -
#pragma mark Representation & Navigation

/*! copy the current TNXMLNode
@return a copy of this
*/
Expand Down

0 comments on commit a7fb546

Please sign in to comment.