Index: src/XMPPAuthenticator.h ================================================================== --- src/XMPPAuthenticator.h +++ src/XMPPAuthenticator.h @@ -33,32 +33,32 @@ OFString *password; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The authzid to get authorization for +/// \brief The authzid to get authorization for @property (copy) OFString *authzid; -/// The authcid to authenticate with +/// \brief The authcid to authenticate with @property (copy) OFString *authcid; -/// The password to authenticate with +/// \brief The password to authenticate with @property (copy) OFString *password; #endif /** - * Initializes an already allocated XMPPAuthenticator with an authcid - * and password. + * \brief Initializes an already allocated XMPPAuthenticator with an authcid + * and password. * * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \return A initialized XMPPAuthenticator */ - initWithAuthcid: (OFString*)authcid password: (OFString*)password; /** - * Initializes an already allocated XMPPSCRAMAuthenticator with an authzid, - * authcid and password. + * \brief Initializes an already allocated XMPPSCRAMAuthenticator with an + * authzid, authcid and password. * * \param authzid The authzid to get authorization for * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \return A initialized XMPPAuthenticator @@ -66,15 +66,19 @@ - initWithAuthzid: (OFString*)authzid authcid: (OFString*)authcid password: (OFString*)password; /** - * \return A OFDataAray containing the initial authentication message + * \brief Returns an OFDataArray containing the initial authentication message. + * + * \return An OFDataAray containing the initial authentication message */ - (OFDataArray*)initialMessage; /** + * \brief Continue authentication with the specified data. + * * \param data The continuation data send by the server * \return The appropriate response if the data was a challenge, nil otherwise */ - (OFDataArray*)continueWithData: (OFDataArray*)data; Index: src/XMPPConnection.h ================================================================== --- src/XMPPConnection.h +++ src/XMPPConnection.h @@ -168,51 +168,54 @@ /// \brief Whether the connection is encrypted @property (readonly) BOOL encrypted; #endif /** + * \brief Creates a new autoreleased XMPPConnection. + * * \return A new autoreleased XMPPConnection */ + connection; /** - * Adds the specified delegate. + * \brief Adds the specified delegate. * * \param delegate The delegate to add */ - (void)addDelegate: (id )delegate; /** - * Removes the specified delegate. + * \brief Removes the specified delegate. * * \param delegate The delegate to remove */ - (void)removeDelegate: (id )delegate; /** - * Connects to the XMPP service. + * \brief Connects to the XMPP service. */ - (void)connect; /** - * Closes the stream to the XMPP service + * \brief Closes the stream to the XMPP service */ - (void)close; /** - * Checks the certificate presented by the server. - * Throws SSLInvalidCertificateException on failure. + * \brief Checks the certificate presented by the server. + * + * \throw SSLInvalidCertificateException Thrown if the certificate is invalid */ - (void)checkCertificate; /** - * Starts a loop handling incomming data. + * \brief Starts a loop handling incomming data. */ - (void)handleConnection; /** - * Parses the specified buffer. + * \brief Parses the specified buffer. * * This is useful for handling multiple connections at once. * * \param buffer The buffer to parse * \param length The length of the buffer. If length is 0, it is assumed that @@ -220,40 +223,46 @@ */ - (void)parseBuffer: (const char*)buffer withLength: (size_t)length; /** + * \brief Returns the socket used by the XMPPConnection. + * * \return The socket used by the XMPPConnection */ - (OFTCPSocket*)socket; /** + * \brief Returns whether encryption is encrypted. + * * \return Whether encryption is encrypted */ - (BOOL)encryptionRequired; /** - * Sets whether encryption is required. + * \brief Sets whether encryption is required. * * \param required Whether encryption is required */ - (void)setEncryptionRequired: (BOOL)required; /** + * \brief Returns whether the connection is encrypted. + * * \return Whether the connection is encrypted */ - (BOOL)encrypted; /** - * Sends an OFXMLElement, usually an XMPPStanza. + * \brief Sends an OFXMLElement, usually an XMPPStanza. * * \param element The element to send */ - (void)sendStanza: (OFXMLElement*)element; /** - * Sends an XMPPIQ, registering a callback method + * \brief Sends an XMPPIQ, registering a callback method. * * \param object The object that contains the callback method * \param selector The selector of the callback method, * must take exactly one parameter of type XMPPIQ* */ @@ -261,20 +270,20 @@ withCallbackObject: (id)object selector: (SEL)selector; #ifdef OF_HAVE_BLOCKS /** - * Sends an XMPPIQ, registering a callback block + * \brief Sends an XMPPIQ, registering a callback block. * * \param callback The callback block */ - (void)sendIQ: (XMPPIQ*)iq withCallbackBlock: (void(^)(XMPPIQ*))block; #endif /** - * Generates a new, unique stanza ID. + * \brief Generates a new, unique stanza ID. * * \return A new, generated, unique stanza ID. */ - (OFString*)generateStanzaID; Index: src/XMPPEXTERNALAuth.h ================================================================== --- src/XMPPEXTERNALAuth.h +++ src/XMPPEXTERNALAuth.h @@ -26,19 +26,19 @@ /** * \brief A class to authenticate using SASL EXTERNAL */ @interface XMPPEXTERNALAuth: XMPPAuthenticator /** - * Creates a new autoreleased XMPPEXTERNALAuth. + * \brief Creates a new autoreleased XMPPEXTERNALAuth. * * \return A new autoreleased XMPPEXTERNALAuth */ + EXTERNALAuth; /** - * Creates a new autoreleased XMPPEXTERNALAuth with an authzid. + * \brief Creates a new autoreleased XMPPEXTERNALAuth with an authzid. * * \param authzid The authzid to get authorization for * \return A new autoreleased XMPPEXTERNALAuth */ + EXTERNALAuthWithAuthzid: (OFString*)authzid; @end Index: src/XMPPExceptions.h ================================================================== --- src/XMPPExceptions.h +++ src/XMPPExceptions.h @@ -34,16 +34,16 @@ XMPPConnection *connection; /// \end } #ifdef OF_HAVE_PROPERTIES -/// The connection the exception relates to +/// \brief The connection the exception relates to @property (readonly, assign) XMPPConnection *connection; #endif /** - * Creates a new XMPPException + * \brief Creates a new XMPPException. * * \param class_ The class of the object which caused the exception * \param connection The connection that received the data responsible * for this exception * \return A new XMPPException @@ -50,11 +50,11 @@ */ + exceptionWithClass: (Class)class_ connection: (XMPPConnection*)connection; /** - * Initializes an already allocated XMPPException + * \brief Initializes an already allocated XMPPException. * * \param class_ The class of the object which caused the exception * \param connection The connection that received the data responsible * for this exception * \return An initialized XMPPException @@ -75,18 +75,18 @@ OFString *reason; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The defined error condition specified by the stream error +/// \brief The defined error condition specified by the stream error @property (readonly, assign) OFString *condition; -/// The descriptive free-form text specified by the stream error +/// \brief The descriptive free-form text specified by the stream error @property (readonly, assign) OFString *reason; #endif /** - * Creates a new XMPPStreamErrorException + * \brief Creates a new XMPPStreamErrorException. * * \param class_ The class of the object which caused the exception * \param connection The connection that received the stream error * \param condition The defined error condition specified by the stream error * \param reason The descriptive free-form text specified by the stream error @@ -96,11 +96,11 @@ connection: (XMPPConnection*)connection condition: (OFString*)condition reason: (OFString*)reason; /** - * Initializes an already allocated XMPPStreamErrorException + * \brief Initializes an already allocated XMPPStreamErrorException. * * \param class_ The class of the object which caused the exception * \param connection The connection that received the stream error * \param condition The defined error condition specified by the stream error * \param reason The descriptive free-form text specified by the stream error @@ -126,18 +126,18 @@ OFString *string; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The name of the stringprep profile that did not apply +/// \brief The name of the stringprep profile that did not apply @property (readonly, assign) OFString *profile; -/// The string that failed the stringprep profile +/// \brief The string that failed the stringprep profile @property (readonly, assign) OFString *string; #endif /** - * Creates a new XMPPStringPrepFailedException + * \brief Creates a new XMPPStringPrepFailedException. * * \param class_ The class of the object which caused the exception * \param connection The connection the string relates to * \param profile The name of the stringprep profile that did not apply * \param string The string that failed the stringprep profile @@ -147,11 +147,11 @@ connection: (XMPPConnection*)connection profile: (OFString*)profile string: (OFString*)string; /** - * Initializes an already allocated XMPPStringPrepFailedException + * \brief Initializes an already allocated XMPPStringPrepFailedException. * * \param class_ The class of the object which caused the exception * \param connection The connection the string relates to * \param profile The name of the stringprep profile that did not apply * \param string The string that failed the stringprep profile @@ -176,18 +176,18 @@ OFString *string; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The IDNA translation operation which failed +/// \brief The IDNA translation operation which failed @property (readonly, assign) OFString *operation; -/// The string that could not be translated +/// \brief The string that could not be translated @property (readonly, assign) OFString *string; #endif /** - * Creates a new XMPPIDNATranslationFailedException + * \brief Creates a new XMPPIDNATranslationFailedException. * * \param class_ The class of the object which caused the exception * \param connection The connection the string relates to * \param operation The name of the stringprep profile that did not apply * \param string The string that could not be translated @@ -197,11 +197,11 @@ connection: (XMPPConnection*)connection operation: (OFString*)operation string: (OFString*)string; /** - * Initializes an already allocated XMPPIDNATranslationFailedException + * \brief Initializes an already allocated XMPPIDNATranslationFailedException. * * \param class_ The class of the object which caused the exception * \param connection The connection the string relates to * \param operation The name of the stringprep profile that did not apply * \param string The string that could not be translated @@ -225,16 +225,16 @@ OFString *reason; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The reason the authentication failed +/// \brief The reason the authentication failed @property (readonly, assign) OFString *reason; #endif /** - * Creates a new XMPPAuthFailedException + * \brief Creates a new XMPPAuthFailedException. * * \param class_ The class of the object which caused the exception * \param connection The connection that could not be authenticated * \param reason The reason the authentication failed * \return A new XMPPAuthFailedException @@ -242,11 +242,11 @@ + exceptionWithClass: (Class)class_ connection: (XMPPConnection*)connection reason: (OFString*)reason; /** - * Initializes an already allocated XMPPAuthFailedException + * \brief Initializes an already allocated XMPPAuthFailedException. * * \param class_ The class of the object which caused the exception * \param connection The connection that could not be authenticated * \param reason The reason the authentication failed * \return An initialized XMPPAuthFailedException Index: src/XMPPIQ.h ================================================================== --- src/XMPPIQ.h +++ src/XMPPIQ.h @@ -26,53 +26,54 @@ /** * \brief A class describing an IQ stanza. */ @interface XMPPIQ: XMPPStanza /** - * Creates a new XMPPIQ with the specified type and id. + * \brief Creates a new XMPPIQ with the specified type and ID. * * \param type The value for the stanza's type attribute * \param ID The value for the stanza's id attribute * \return A new autoreleased XMPPIQ */ + IQWithType: (OFString*)type ID: (OFString*)ID; /** - * Initializes an already allocated XMPPIQ with the specified type and id + * \brief Initializes an already allocated XMPPIQ with the specified type and + * ID. * * \param type The value for the stanza's type attribute * \param ID The value for the stanza's id attribute * \return An initialized XMPPIQ */ - initWithType: (OFString*)type ID: (OFString*)ID; /** - * Generates a result IQ for the receiving object + * \brief Generates a result IQ for the receiving object. * * \return A new autoreleased XMPPIQ */ - (XMPPIQ*)resultIQ; /** - * Generates a error IQ for the receiving object + * \brief Generates an error IQ for the receiving object. * - * \param type A error type as defined by RFC 6120 - * \param condition A error condition as defined by RFC 6120 + * \param type An error type as defined by RFC 6120 + * \param condition An error condition as defined by RFC 6120 * \param text A descriptive text * \return A new autoreleased XMPPIQ */ - (XMPPIQ*)errorIQWithType: (OFString*)type condition: (OFString*)condition text: (OFString*)text; /** - * Generates a error IQ for the receiving object + * \brief Generates an error IQ for the receiving object. * - * \param type A error type as defined by RFC 6120 + * \param type An error type as defined by RFC 6120 * \param condition A defined conditions from RFC 6120 * \return A new autoreleased XMPPIQ */ - (XMPPIQ*)errorIQWithType: (OFString*)type condition: (OFString*)condition; @end Index: src/XMPPJID.h ================================================================== --- src/XMPPJID.h +++ src/XMPPJID.h @@ -34,47 +34,51 @@ OFString *resource; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The JID's localpart +/// \brief The JID's localpart @property (copy) OFString *node; -/// The JID's domainpart +/// \brief The JID's domainpart @property (copy) OFString *domain; -/// The JID's resourcepart +/// \brief The JID's resourcepart @property (copy) OFString *resource; #endif /** - * Creates a new autoreleased XMPPJID. + * \brief Creates a new autoreleased XMPPJID. * * \return A new autoreleased XMPPJID */ + JID; /** - * Creates a new autoreleased XMPPJID from a string. + * \brief Creates a new autoreleased XMPPJID from a string. * * \param str The string to parse into a JID object * \return A new autoreleased XMPPJID */ + JIDWithString: (OFString*)str; /** - * Initializes an already allocated XMPPJID with a string. + * \brief Initializes an already allocated XMPPJID with a string. * * \param str The string to parse into a JID object * \return A initialized XMPPJID */ - initWithString: (OFString*)str; /** + * \brief Returns the bare JID. + * * \return An OFString containing the bare JID */ - (OFString*)bareJID; /** + * \brief Returns the full JID. + * * \return An OFString containing the full JID */ - (OFString*)fullJID; - (void)setNode: (OFString*)node; Index: src/XMPPMessage.h ================================================================== --- src/XMPPMessage.h +++ src/XMPPMessage.h @@ -26,88 +26,83 @@ /** * \brief A class describing a message stanza. */ @interface XMPPMessage: XMPPStanza #ifdef OF_HAVE_PROPERTIES +/// \brief The text content of the body of the message @property (copy) OFString *body; #endif /** - * Creates a new autoreleased XMPPMessage. + * \brief Creates a new autoreleased XMPPMessage. * * \return A new autoreleased XMPPMessage */ + message; /** - * Creates a new autoreleased XMPPMessage with the specified id. + * \brief Creates a new autoreleased XMPPMessage with the specified ID. * * \param ID The value for the stanza's id attribute * \return A new autoreleased XMPPMessage */ + messageWithID: (OFString*)ID; /** - * Creates a new autoreleased XMPPMessage with the specified type. + * \brief Creates a new autoreleased XMPPMessage with the specified type. * * \param type The value for the stanza's type attribute * \return A new autoreleased XMPPMessage */ + messageWithType: (OFString*)type; /** - * Creates a new autoreleased XMPPMessage with the specified type and id. + * \brief Creates a new autoreleased XMPPMessage with the specified type and ID. * * \param type The value for the stanza's type attribute * \param ID The value for the stanza's id attribute * \return A new autoreleased XMPPMessage */ + messageWithType: (OFString*)type ID: (OFString*)ID; /** - * Initializes an already allocated XMPPMessage. - * - * \return A initialized XMPPMessage - */ -- init; - -/** - * Initializes an already allocated XMPPMessage with the specified id. + * \brief Initializes an already allocated XMPPMessage with the specified ID. * * \param ID The value for the stanza's id attribute * \return A initialized XMPPMessage */ - initWithID: (OFString*)ID; /** - * Initializes an already allocated XMPPMessage with the specified type. + * \brief Initializes an already allocated XMPPMessage with the specified type. * * \param type The value for the stanza's type attribute * \return A initialized XMPPMessage */ - initWithType: (OFString*)type; /** - * Initializes an already allocated XMPPMessage with the specified type and id. + * \brief Initializes an already allocated XMPPMessage with the specified type + * and ID. * * \param type The value for the stanza's type attribute * \param ID The value for the stanza's id attribute * \return A initialized XMPPMessage */ - initWithType: (OFString*)type ID: (OFString*)ID; /** - * Sets the text content of the body of the XMPPMessage. + * \brief Sets the text content of the body of the XMPPMessage. * * \param body The text content of the body element or nil to remove the body */ - (void)setBody: (OFString*)body; /** - * Returns the text content of the body element of the XMPPMessage. + * \brief Returns the text content of the body element of the XMPPMessage. * * \return The text content of the body element of the XMPPMessage. */ - (OFString*)body; @end Index: src/XMPPMulticastDelegate.h ================================================================== --- src/XMPPMulticastDelegate.h +++ src/XMPPMulticastDelegate.h @@ -33,38 +33,38 @@ OFDataArray *delegates; /// \endcond } /** - * Adds a delegate to the set of managed delegates + * \brief Adds a delegate which should receive the broadcasts. * * \param delegate The delegate to add */ - (void)addDelegate: (id)delegate; /** - * Removes a delegate from the set of managed delegates + * \brief Removes a delegate so it does not receive the broadcasts anymore. * * \param delegate The delegate to remove */ - (void)removeDelegate: (id)delegate; /** - * Broadcasts a selector with one object to all managed delegates + * \brief Broadcasts a selector with an object to all registered delegates. * * \param selector The selector to broadcast * \param object The object to broadcast */ - (BOOL)broadcastSelector: (SEL)selector withObject: (id)object; /** - * Broadcasts a selector with two objects to all managed delegates + * \brief Broadcasts a selector with two objects to all registered delegates. * * \param selector The selector to broadcast * \param object1 The first object to broadcast * \param object2 The second object to broadcast */ - (BOOL)broadcastSelector: (SEL)selector withObject: (id)object1 withObject: (id)object2; @end Index: src/XMPPPLAINAuth.h ================================================================== --- src/XMPPPLAINAuth.h +++ src/XMPPPLAINAuth.h @@ -26,22 +26,22 @@ /** * \brief A class to authenticate using SASL PLAIN */ @interface XMPPPLAINAuth: XMPPAuthenticator /** - * Creates a new autoreleased XMPPPLAINAuth with an authcid and password. + * \brief Creates a new autoreleased XMPPPLAINAuth with an authcid and password. * * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \return A new autoreleased XMPPPLAINAuth */ + PLAINAuthWithAuthcid: (OFString*)authcid password: (OFString*)password; /** - * Creates a new autoreleased XMPPPLAINAuth with an authzid, - * authcid and password. + * \brief Creates a new autoreleased XMPPPLAINAuth with an authzid, authcid and + * password. * * \param authzid The authzid to get authorization for * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \return A new autoreleased XMPPPLAINAuth Index: src/XMPPPresence.h ================================================================== --- src/XMPPPresence.h +++ src/XMPPPresence.h @@ -26,91 +26,86 @@ /** * \brief A class describing a presence stanza. */ @interface XMPPPresence: XMPPStanza /** - * Creates a new autoreleased XMPPPresence. + * \brief Creates a new autoreleased XMPPPresence. * * \return A new autoreleased XMPPPresence */ + presence; /** - * Creates a new autoreleased XMPPPresence with the specified id. + * \brief Creates a new autoreleased XMPPPresence with the specified ID. * * \param ID The value for the stanza's id attribute * \return A new autoreleased XMPPPresence */ + presenceWithID: (OFString*)ID; /** - * Creates a new autoreleased XMPPPresence with the specified type. + * \brief Creates a new autoreleased XMPPPresence with the specified type. * * \param type The value for the stanza's type attribute * \return A new autoreleased XMPPPresence */ + presenceWithType: (OFString*)type; /** - * Creates a new autoreleased XMPPPresence with the specified type and id. + * \brief Creates a new autoreleased XMPPPresence with the specified type and + * ID. * * \param type The value for the stanza's type attribute * \param ID The value for the stanza's id attribute * \return A new autoreleased XMPPPresence */ + presenceWithType: (OFString*)type ID: (OFString*)ID; /** - * Initializes an already allocated XMPPPresence. - * - * \return A initialized XMPPPresence - */ -- init; - -/** - * Initializes an already allocated XMPPPresence with the specified id. + * \brief Initializes an already allocated XMPPPresence with the specified ID. * * \param ID The value for the stanza's id attribute * \return A initialized XMPPPresence */ - initWithID: (OFString*)ID; /** - * Initializes an already allocated XMPPPresence with the specified type. + * \brief Initializes an already allocated XMPPPresence with the specified type. * * \param type The value for the stanza's type attribute * \return A initialized XMPPPresence */ - initWithType: (OFString*)type; /** - * Initializes an already allocated XMPPPresence with the specified type and id. + * \brief Initializes an already allocated XMPPPresence with the specified type + * and ID. * * \param type The value for the stanza's type attribute * \param ID The value for the stanza's id attribute * \return A initialized XMPPPresence */ - initWithType: (OFString*)type ID: (OFString*)ID; /** - * Adds a show element to the presence stanza. + * \brief Adds a show element to the presence stanza. * * \param show The text content of the show element */ - (void)addShow: (OFString*)show; /** - * Adds a status element to the presence stanza. + * \brief Adds a status element to the presence stanza. * * \param status The text content of the status element */ - (void)addStatus: (OFString*)status; /** - * Adds a priority element to the presence stanza. + * \brief Adds a priority element to the presence stanza. * * \param priority The text content of the priority element */ - (void)addPriority: (int8_t)priority; @end Index: src/XMPPRoster.h ================================================================== --- src/XMPPRoster.h +++ src/XMPPRoster.h @@ -40,29 +40,29 @@ #endif #ifdef OF_HAVE_OPTIONAL_PROTOCOLS @optional #endif /** - * This callback is called after the roster was received (as a result of - * calling -requestRoster. + * \brief This callback is called after the roster was received (as a result of + * calling -requestRoster). * * \param roster The roster that was received */ - (void)rosterWasReceived: (XMPPRoster*)roster; /** - * This callback is called whenever a roster push was received. + * \brief This callback is called whenever a roster push was received. * * \param roster The roster that was updated by the roster push * \param rosterItem The roster item received in the push */ - (void)roster: (XMPPRoster*)roster didReceiveRosterItem: (XMPPRosterItem*)rosterItem; @end /** - * \brief A class implementing roster related functionality + * \brief A class implementing roster related functionality. */ @interface XMPPRoster: OFObject #ifdef OF_HAVE_OPTIONAL_PROTOCOLS #endif @@ -73,60 +73,61 @@ XMPPMulticastDelegate *delegates; /// \endcond } /** - * Initializes an already allocated XMPPRoster + * \brief Initializes an already allocated XMPPRoster. * * \param connection The connection roster related stanzas * are send and received over * \return An initialized XMPPRoster */ - initWithConnection: (XMPPConnection*)connection; /** - * Returns the list of contacts as a OFDictionary with the bare JID as key + * \brief Returns the list of contacts as an OFDictionary with the bare JID as + * a string as key. * * \return An autoreleased copy of the dictionary containing the roster items */ - (OFDictionary*)rosterItems; /** - * Requests the roster from the server + * \brief Requests the roster from the server. */ - (void)requestRoster; /** - * Adds a new contact to the roster + * \brief Adds a new contact to the roster. * * \param rosterItem The roster item to add to the roster */ - (void)addRosterItem: (XMPPRosterItem*)rosterItem; /** - * Updates an already existing contact in the roster + * \brief Updates an already existing contact in the roster. * * \param rosterItem The roster item to update */ - (void)updateRosterItem: (XMPPRosterItem*)rosterItem; /** - * Delete a contact from the roster + * \brief Delete a contact from the roster. * * \param rosterItem The roster item to delete */ - (void)deleteRosterItem: (XMPPRosterItem*)rosterItem; /** - * Adds the specified delegate + * \brief Adds the specified delegate. * * \param delegate The delegate to add */ - (void)addDelegate: (id )delegate; /** - * Removes the specified delegate + * \brief Removes the specified delegate. * * \param delegate The delegate to remove */ - (void)removeDelegate: (id )delegate; Index: src/XMPPRosterItem.h ================================================================== --- src/XMPPRosterItem.h +++ src/XMPPRosterItem.h @@ -1,7 +1,7 @@ /* - * Copyright (c) 2011, Jonathan Schleifer + * Copyright (c) 2011, 2012, Jonathan Schleifer * * https://webkeks.org/hg/objxmpp/ * * Permission to use, copy, modify, and/or distribute this software for any * purpose with or without fee is hereby granted, provided that the above @@ -36,21 +36,31 @@ OFArray *groups; /// \endcond } #ifdef OF_HAVE_PROPERTIES +/// \brief The JID of the roster item @property (copy) XMPPJID *JID; +/// \brief The name of the roster item to show to the user @property (copy) OFString *name; +/// \brief The subscription for the roster item @property (copy) OFString *subscription; +/// \brief An array of groups in which the roster item is @property (copy) OFArray *groups; #endif +/** + * \brief Creates a new autoreleased roster item. + * + * \return A new autoreleased roster item. + */ + rosterItem; + - (void)setJID: (XMPPJID*)JID; - (XMPPJID*)JID; - (void)setName: (OFString*)name; - (OFString*)name; - (void)setSubscription: (OFString*)subscription; - (OFString*)subscription; - (void)setGroups: (OFArray*)groups; - (OFArray*)groups; @end Index: src/XMPPSCRAMAuth.h ================================================================== --- src/XMPPSCRAMAuth.h +++ src/XMPPSCRAMAuth.h @@ -40,11 +40,11 @@ BOOL authenticated; /// \endcond } /** - * Creates a new autoreleased XMPPSCRAMAuth with an authcid and password. + * \brief Creates a new autoreleased XMPPSCRAMAuth with an authcid and password. * * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \param connection The connection over which authentication is done * \param hash The class to use for calulating hashes @@ -56,12 +56,12 @@ connection: (XMPPConnection*)connection hash: (Class)hash plusAvailable: (BOOL)plusAvailable; /** - * Creates a new autoreleased XMPPSCRAMAuth with an authzid, - * authcid and password. + * \brief Creates a new autoreleased XMPPSCRAMAuth with an authzid, authcid and + * password. * * \param authzid The authzid to get authorization for * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \param connection The connection over which authentication is done @@ -75,11 +75,12 @@ connection: (XMPPConnection*)connection hash: (Class)hash plusAvailable: (BOOL)plusAvailable; /** - * Initializes an already allocated XMPPSCRAMAuth with an authcid and password. + * \brief Initializes an already allocated XMPPSCRAMAuth with an authcid and + * password. * * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \param connection The connection over which authentication is done * \param hash The class to use for calulating hashes @@ -91,12 +92,12 @@ connection: (XMPPConnection*)connection hash: (Class)hash plusAvailable: (BOOL)plusAvailable; /** - * Initializes an already allocated XMPPSCRAMAuth with a authzid, - * authcid and password. + * \brief Initializes an already allocated XMPPSCRAMAuth with a authzid, + * authcid and password. * * \param authzid The authzid to get authorization for * \param authcid The authcid to authenticate with * \param password The password to authenticate with * \param connection The connection over which authentication is done Index: src/XMPPStanza.h ================================================================== --- src/XMPPStanza.h +++ src/XMPPStanza.h @@ -37,50 +37,52 @@ OFString *ID; /// \endcond } #ifdef OF_HAVE_PROPERTIES -/// The value of the stanza's from attribute +/// \brief The value of the stanza's from attribute @property (copy) XMPPJID *from; -/// The value of the stanza's to attribute +/// \brief The value of the stanza's to attribute @property (copy) XMPPJID *to; -/// The value of the stanza's type attribute +/// \brief The value of the stanza's type attribute @property (copy) OFString *type; -/// The value of the stanza's id attribute +/// \brief The value of the stanza's id attribute @property (copy) OFString *ID; #endif /** - * Creates a new autoreleased XMPPStanza with the specified name. + * \brief 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 */ + stanzaWithName: (OFString*)name; /** - * Creates a new autoreleased XMPPStanza with the specified name and type. + * \brief 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 * \return A new autoreleased XMPPStanza */ + stanzaWithName: (OFString*)name type: (OFString*)type; /** - * Creates a new autoreleased XMPPStanza with the specified name and id. + * \brief 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 * \return A new autoreleased XMPPStanza */ + stanzaWithName: (OFString*)name ID: (OFString*)ID; /** - * Creates a new autoreleased XMPPStanza with the specified name, type and id. + * \brief 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 * \param ID The value for the stanza's id attribute * \return A new autoreleased XMPPStanza @@ -88,48 +90,50 @@ + stanzaWithName: (OFString*)name type: (OFString*)type ID: (OFString*)ID; /** - * Creates a new autoreleased XMPPStanza from an OFXMLElement. + * \brief Creates a new autoreleased XMPPStanza from an OFXMLElement. * * \param element The element to base the XMPPStanza on * \return A new autoreleased XMPPStanza */ + stanzaWithElement: (OFXMLElement*)element; /** - * Initializes an already allocated XMPPStanza with the specified name. + * \brief 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 */ - initWithName: (OFString*)name; /** - * Initializes an already allocated XMPPStanza with the specified name and type. + * \brief 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; /** - * Initializes an already allocated XMPPStanza with the specified name and id. + * \brief 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; /** - * Initializes an already allocated XMPPStanza with the specified name, type - * and id. + * \brief 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 * \param ID The value for the stanza's id attribute * \return A initialized XMPPStanza @@ -137,11 +141,11 @@ - initWithName: (OFString*)name type: (OFString*)type ID: (OFString*)ID; /** - * Initializes an already allocated XMPPStanza based on a OFXMLElement + * \brief Initializes an already allocated XMPPStanza based on a OFXMLElement. * * \param element The element to base the XMPPStanza on * \return A initialized XMPPStanza */ - initWithElement: (OFXMLElement*)element;