Index: Doxyfile ================================================================== --- Doxyfile +++ Doxyfile @@ -3,7 +3,18 @@ INPUT = src FILE_PATTERNS = *.h *.m HTML_OUTPUT = . GENERATE_LATEX = NO HIDE_UNDOC_CLASSES = YES -PREDEFINED = OF_HAVE_PROPERTIES +HIDE_UNDOC_MEMBERS = YES +PREDEFINED = OF_HAVE_PROPERTIES \ + OF_HAVE_BLOCKS \ + OF_HAVE_THREADS \ + OF_SENTINEL \ + OF_RETURNS_RETAINED \ + OF_RETURNS_NOT_RETAINED \ + OF_RETURNS_INNER_POINTER \ + OF_CONSUMED \ + OF_WEAK_UNAVAILABLE +MACRO_EXPANSION = YES +EXPAND_ONLY_PREDEF = YES IGNORE_PREFIX = XMPP Index: src/XMPPAuthenticator.h ================================================================== --- src/XMPPAuthenticator.h +++ src/XMPPAuthenticator.h @@ -25,15 +25,13 @@ /** * \brief A base class for classes implementing authentication mechanisms */ @interface XMPPAuthenticator: OFObject { -/// \cond internal OFString *_authzid; OFString *_authcid; OFString *_password; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The authzid to get authorization for @property (copy) OFString *authzid; Index: src/XMPPConnection.h ================================================================== --- src/XMPPConnection.h +++ src/XMPPConnection.h @@ -114,18 +114,18 @@ * * \param connection The connection that was closed */ - (void)connectionWasClosed: (XMPPConnection*)connection; -/** - * \brief This callback is called when the connection threw an exception. - * - * This is only called for connections on which \ref handleConnection: has been - * called. - * - * \param connection The connection which threw an exception - * \param exception The exception the connection threw +/*! + * @brief This callback is called when the connection threw an exception. + * + * This is only called for connections on which + * @ref XMPPConnection::handleConnection has been called. + * + * @param connection The connection which threw an exception + * @param exception The exception the connection threw */ - (void)connection: (XMPPConnection*)connection didThrowException: (OFException*)exception; /** @@ -150,11 +150,10 @@ @interface XMPPConnection: OFObject #ifdef OF_HAVE_OPTONAL_PROTOCOLS #endif { -/// \cond internal id _socket; OFXMLParser *_parser, *_oldParser; OFXMLElementBuilder *_elementBuilder, *_oldElementBuilder; OFString *_username, *_password, *_server, *_resource; OFString *_privateKeyFile, *_certificateFile; @@ -170,11 +169,10 @@ BOOL _needsSession; BOOL _encryptionRequired, _encrypted; BOOL _supportsRosterVersioning; BOOL _supportsStreamManagement; unsigned int _lastID; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The username to use for authentication @property (copy) OFString *username; @@ -312,28 +310,30 @@ * * \param element The element to send */ - (void)sendStanza: (OFXMLElement*)element; -/** - * \brief Sends an XMPPIQ, registering a callback method. +/*! + * @brief Sends an XMPPIQ, registering a callback method. * - * \param target The object that contains the callback method - * \param selector The selector of the callback method, + * @param IQ The IQ to send + * @param target The object that contains the callback method + * @param selector The selector of the callback method, * must take exactly one parameter of type XMPPIQ* */ -- (void)sendIQ: (XMPPIQ*)iq +- (void)sendIQ: (XMPPIQ*)IQ callbackTarget: (id)target selector: (SEL)selector; #ifdef OF_HAVE_BLOCKS -/** - * \brief Sends an XMPPIQ, registering a callback block. +/*! + * @brief Sends an XMPPIQ, registering a callback block. * - * \param block The callback block + * @param IQ The IQ to send + * @param block The callback block */ -- (void)sendIQ: (XMPPIQ*)iq +- (void)sendIQ: (XMPPIQ*)IQ callbackBlock: (xmpp_callback_block_t)block; #endif /** * \brief Generates a new, unique stanza ID. @@ -360,11 +360,10 @@ - (void)setLanguage: (OFString*)language; - (OFString*)language; - (BOOL)supportsRosterVersioning; - (BOOL)supportsStreamManagement; -/// \cond internal - (void)XMPP_startStream; - (void)XMPP_handleStream: (OFXMLElement*)element; - (void)XMPP_handleTLS: (OFXMLElement*)element; - (void)XMPP_handleSASL: (OFXMLElement*)element; - (void)XMPP_handleStanza: (OFXMLElement*)element; @@ -381,10 +380,9 @@ - (void)XMPP_sendSession; - (void)XMPP_handleSessionForConnection: (XMPPConnection*)connection IQ: (XMPPIQ*)iq; - (OFString*)XMPP_IDNAToASCII: (OFString*)domain; - (XMPPMulticastDelegate*)XMPP_delegates; -/// \endcond @end @interface OFObject (XMPPConnectionDelegate) @end Index: src/XMPPConnection.m ================================================================== --- src/XMPPConnection.m +++ src/XMPPConnection.m @@ -562,47 +562,47 @@ withObject: element]; [_socket writeString: [element XMLString]]; } -- (void)sendIQ: (XMPPIQ*)iq +- (void)sendIQ: (XMPPIQ*)IQ callbackTarget: (id)target selector: (SEL)selector { OFAutoreleasePool *pool; XMPPCallback *callback; - if (![iq ID]) - [iq setID: [self generateStanzaID]]; + if (![IQ ID]) + [IQ setID: [self generateStanzaID]]; pool = [[OFAutoreleasePool alloc] init]; callback = [XMPPCallback callbackWithTarget: target selector: selector]; [_callbacks setObject: callback - forKey: [iq ID]]; + forKey: [IQ ID]]; [pool release]; - [self sendStanza: iq]; + [self sendStanza: IQ]; } #ifdef OF_HAVE_BLOCKS -- (void)sendIQ: (XMPPIQ*)iq +- (void)sendIQ: (XMPPIQ*)IQ callbackBlock: (xmpp_callback_block_t)block { OFAutoreleasePool *pool; XMPPCallback *callback; - if (![iq ID]) - [iq setID: [self generateStanzaID]]; + if (![IQ ID]) + [IQ setID: [self generateStanzaID]]; pool = [[OFAutoreleasePool alloc] init]; callback = [XMPPCallback callbackWithBlock: block]; [_callbacks setObject: callback - forKey: [iq ID]]; + forKey: [IQ ID]]; [pool release]; - [self sendStanza: iq]; + [self sendStanza: IQ]; } #endif - (OFString*)generateStanzaID { Index: src/XMPPContact.h ================================================================== --- src/XMPPContact.h +++ src/XMPPContact.h @@ -31,16 +31,15 @@ /** * \brief A class describing a contact tracked by a XMPPContactManager */ @interface XMPPContact: OFObject { -/// \cond internal XMPPRosterItem *_rosterItem; OFMutableDictionary *_presences; XMPPJID *_lockedOnJID; -/// \endcond } + #ifdef OF_HAVE_PROPERTIES /// \brief The XMPPRosterItem corresponding to this contact @property (readonly) XMPPRosterItem *rosterItem; /// \brief The XMPPPresences of this contact with the resources as keys @property (readonly) OFDictionary *presences; @@ -53,13 +52,11 @@ * \param connection The connection to use for sending the message */ - (void)sendMessage: (XMPPMessage*)message connection: (XMPPConnection*)connection; -/// \cond internal - (void)XMPP_setRosterItem: (XMPPRosterItem*)rosterItem; - (void)XMPP_setPresence: (XMPPPresence*)presence resource: (OFString*)resource; - (void)XMPP_removePresenceForResource: (OFString*)resource; - (void)XMPP_setLockedOnJID: (XMPPJID*)JID; -/// \endcond @end Index: src/XMPPContactManager.h ================================================================== --- src/XMPPContactManager.h +++ src/XMPPContactManager.h @@ -95,27 +95,27 @@ @interface XMPPContactManager: OFObject #ifdef OF_HAVE_OPTIONAL_PROTOCOLS #endif { -/// \cond internal OFMutableDictionary *_contacts; XMPPConnection *_connection; XMPPRoster *_roster; XMPPMulticastDelegate *_delegates; -/// \endcond } + #ifdef OF_HAVE_PROPERTIES /// \brief The tracked contacts, with their bare JID as key @property (readonly) OFDictionary *contacts; #endif -/** - * \brief Initializes an already allocated XMPPContactManager. +/*! + * @brief Initializes an already allocated XMPPContactManager. * - * \param connection The connection to be used to track contacts - * \return An initialized XMPPContactManager + * @param connection The connection to be used to track contacts + * @param roster The roster used by the contact manager + * @return An initialized XMPPContactManager */ - initWithConnection: (XMPPConnection*)connection roster: (XMPPRoster*)roster; /** Index: src/XMPPExceptions.h ================================================================== --- src/XMPPExceptions.h +++ src/XMPPExceptions.h @@ -28,13 +28,11 @@ /** * \brief A base class for XMPP related exceptions */ @interface XMPPException: OFException { -/// \cond internal XMPPConnection *_connection; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The connection the exception relates to @property (readonly, assign) XMPPConnection *connection; @@ -68,14 +66,12 @@ /** * \brief An exception indicating a stream error was received */ @interface XMPPStreamErrorException: XMPPException { -/// \cond internal OFString *_condition; OFString *_reason; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The defined error condition specified by the stream error @property (readonly, assign) OFString *condition; @@ -119,14 +115,12 @@ * \brief An exception indicating a stringprep profile * did not apply to a string */ @interface XMPPStringPrepFailedException: XMPPException { -/// \cond internal OFString *_profile; OFString *_string; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The name of the stringprep profile that did not apply @property (readonly, assign) OFString *profile; @@ -169,14 +163,12 @@ /** * \brief An exception indicating IDNA translation of a string failed */ @interface XMPPIDNATranslationFailedException: XMPPException { -/// \cond internal OFString *_operation; OFString *_string; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The IDNA translation operation which failed @property (readonly, assign) OFString *operation; @@ -219,13 +211,11 @@ /** * \brief An exception indicating authentication failed */ @interface XMPPAuthFailedException: XMPPException { -/// \cond internal OFString *_reason; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The reason the authentication failed @property (readonly, assign) OFString *reason; Index: src/XMPPJID.h ================================================================== --- src/XMPPJID.h +++ src/XMPPJID.h @@ -26,15 +26,13 @@ /** * \brief A class for easy handling of JIDs. */ @interface XMPPJID: OFObject { -/// \cond internal OFString *_node; OFString *_domain; OFString *_resource; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The JID's localpart @property (copy) OFString *node; Index: src/XMPPMulticastDelegate.h ================================================================== --- src/XMPPMulticastDelegate.h +++ src/XMPPMulticastDelegate.h @@ -27,13 +27,11 @@ /** * \brief A class to provide multiple delegates in a single class */ @interface XMPPMulticastDelegate: OFObject { -/// \cond internal OFDataArray *_delegates; -/// \endcond } /** * \brief Adds a delegate which should receive the broadcasts. * Index: src/XMPPPresence.h ================================================================== --- src/XMPPPresence.h +++ src/XMPPPresence.h @@ -26,15 +26,13 @@ /** * \brief A class describing a presence stanza. */ @interface XMPPPresence: XMPPStanza { -/// \cond internal OFString *_status; OFString *_show; OFNumber *_priority; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @property (copy) OFString *status; @property (copy) OFString *show; @property (copy) OFNumber *priority; Index: src/XMPPRoster.h ================================================================== --- src/XMPPRoster.h +++ src/XMPPRoster.h @@ -66,17 +66,15 @@ @interface XMPPRoster: OFObject #ifdef OF_HAVE_OPTIONAL_PROTOCOLS #endif { -/// \cond internal XMPPConnection *_connection; OFMutableDictionary *_rosterItems; XMPPMulticastDelegate *_delegates; id _dataStorage; BOOL _rosterRequested; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /** * \brief The connection to which the roster belongs @@ -151,15 +149,13 @@ - (XMPPConnection*)connection; - (void)setDataStorage: (id )dataStorage; - (id )dataStorage; -/// \cond internal - (void)XMPP_updateRosterItem: (XMPPRosterItem*)rosterItem; - (void)XMPP_handleInitialRosterForConnection: (XMPPConnection*)connection IQ: (XMPPIQ*)iq; - (XMPPRosterItem*)XMPP_rosterItemWithXMLElement: (OFXMLElement*)element; -/// \endcond @end @interface OFObject (XMPPRosterDelegate) @end Index: src/XMPPRosterItem.h ================================================================== --- src/XMPPRosterItem.h +++ src/XMPPRosterItem.h @@ -27,16 +27,14 @@ /** * \brief A class for representing an item in the roster. */ @interface XMPPRosterItem: OFObject { -/// \cond internal XMPPJID *_JID; OFString *_name; OFString *_subscription; OFArray *_groups; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The JID of the roster item @property (copy) XMPPJID *JID; Index: src/XMPPSCRAMAuth.h ================================================================== --- src/XMPPSCRAMAuth.h +++ src/XMPPSCRAMAuth.h @@ -27,20 +27,18 @@ /** * \brief A class to authenticate using SCRAM */ @interface XMPPSCRAMAuth: XMPPAuthenticator { -/// \cond internal Class _hashType; OFString *_cNonce; OFString *_GS2Header; OFString *_clientFirstMessageBare; OFDataArray *_serverSignature; XMPPConnection *_connection; BOOL _plusAvailable; BOOL _authenticated; -/// \endcond } /** * \brief Creates a new autoreleased XMPPSCRAMAuth with an authcid and password. * Index: src/XMPPSRVLookup.h ================================================================== --- src/XMPPSRVLookup.h +++ src/XMPPSRVLookup.h @@ -74,14 +74,13 @@ @property (readonly, copy) OFString *domain; #endif + lookupWithDomain: (OFString*)domain; - initWithDomain: (OFString*)domain; -/// \cond internal + - (void)XMPP_lookup; - (void)XMPP_addEntry: (XMPPSRVEntry*)item; -/// \endcond @end @interface XMPPSRVEnumerator: OFEnumerator { OFList *list; Index: src/XMPPStanza.h ================================================================== --- src/XMPPStanza.h +++ src/XMPPStanza.h @@ -28,17 +28,15 @@ /** * \brief A class describing an XMPP Stanza. */ @interface XMPPStanza: OFXMLElement { -/// \cond internal XMPPJID *_from; XMPPJID *_to; OFString *_type; OFString *_ID; OFString *_language; -/// \endcond } #ifdef OF_HAVE_PROPERTIES /// \brief The value of the stanza's from attribute @property (copy) XMPPJID *from; Index: src/XMPPStreamManagement.h ================================================================== --- src/XMPPStreamManagement.h +++ src/XMPPStreamManagement.h @@ -25,13 +25,11 @@ @interface XMPPStreamManagement: OFObject #ifdef OF_HAVE_OPTIONAL_PROTOCOLS #endif { -/// \cond internal XMPPConnection *_connection; uint32_t receivedCount; -/// \endcond } - initWithConnection: (XMPPConnection*)connection; @end