ObjFW/ObjXMPP
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clean up the code.

Browse source
This commit is contained in:
Jonathan Schleifer 2011-02-16 21:05:14 +01:00
parent fa59d3ce32
commit 4690b47ae9
11 changed files with 186 additions and 184 deletions
Download patch file Download diff file Expand all files Collapse all files

48
src/XMPPStanza.h
View file

@ -1,28 +1,17 @@
#import <ObjFW/ObjFW.h>
/**
* \brief A class describing a XMPP Stanza
* \brief A class describing an XMPP Stanza.
*/
@interface XMPPStanza: OFXMLElement
{
/**
* The value of the stanza's from attribute
*/
/// The value of the stanza's from attribute
OFString *from;
/**
* The value of the stanza's to attribute
*/
/// The value of the stanza's to attribute
OFString *to;
/**
* The value of the stanza's type attribute
*/
/// The value of the stanza's type attribute
OFString *type;
/**
* The value of the stanza's id attribute
*/
/// The value of the stanza's id attribute
OFString *ID;
}
@ -32,7 +21,7 @@
@property (copy) OFString *ID;
/**
* Creates a new XMPPStanza with a certain name
* Creates a new autoreleased XMPPStanza with the specified name.
*
* \param name The stanza's name (one of iq, message or presence)
* \return A new autoreleased XMPPStanza
@ -40,7 +29,7 @@
+ stanzaWithName: (OFString*)name;
/**
* Creates a new XMPPStanza with a certain name and type
* Creates a new autoreleased XMPPStanza with the specified name and type.
*
* \param name The stanza's name (one of iq, message or presence)
* \param type The value for the stanza's type attribute
@ -50,7 +39,7 @@
type: (OFString*)type;
/**
* Creates a new XMPPStanza with a certain name and id
* Creates a new autoreleased XMPPStanza with the specified name and id.
*
* \param name The stanza's name (one of iq, message or presence)
* \param ID The value for the stanza's id attribute
@ -60,7 +49,7 @@
ID: (OFString*)ID;
/**
* Creates a new XMPPStanza with a certain name, type and id
* Creates a new autoreleased XMPPStanza with the specified name, type and id.
*
* \param name The stanza's name (one of iq, message or presence)
* \param type The value for the stanza's type attribute
@ -72,7 +61,7 @@
ID: (OFString*)ID;
/**
* Creates a new XMPPStanza from a OFXMLElement
* Creates a new autoreleased XMPPStanza from an OFXMLElement.
*
* \param elem The element to base the XMPPStanza on
* \return A new autoreleased XMPPStanza
@ -80,7 +69,7 @@
+ stanzaWithElement: (OFXMLElement*)elem;
/**
* Initializes an already allocated XMPPStanza with a certain name
* Initializes an already allocated XMPPStanza with the specified name.
*
* \param name The stanza's name (one of iq, message or presence)
* \return A initialized XMPPStanza
@ -88,27 +77,28 @@
- initWithName: (OFString*)name;
/**
* Initializes an already allocated XMPPStanza with a certain name and type
* Initializes an already allocated XMPPStanza with the specified name and type.
*
* \param name The stanza's name (one of iq, message or presence)
* \param type The value for the stanza's type attribute
* \return A initialized XMPPStanza
*/
- initWithName: (OFString*)name
type: (OFString*)type;
type: (OFString*)type;
/**
* Initializes an already allocated XMPPStanza with a certain name and id
* Initializes an already allocated XMPPStanza with the specified name and id.
*
* \param name The stanza's name (one of iq, message or presence)
* \param ID The value for the stanza's id attribute
* \return A initialized XMPPStanza
*/
- initWithName: (OFString*)name
ID: (OFString*)ID;
ID: (OFString*)ID;
/**
* Initializes an already allocated XMPPStanza with a certain name, type and id
* Initializes an already allocated XMPPStanza with the specified name, type
* and id.
*
* \param name The stanza's name (one of iq, message or presence)
* \param type The value for the stanza's type attribute
@ -116,8 +106,8 @@
* \return A initialized XMPPStanza
*/
- initWithName: (OFString*)name
type: (OFString*)type
ID: (OFString*)ID;
type: (OFString*)type
ID: (OFString*)ID;
/**
* Initializes an already allocated XMPPStanza based on a OFXMLElement