diff --git a/Doxyfile b/Doxyfile index afd1b8a..3545c2e 100644 --- a/Doxyfile +++ b/Doxyfile @@ -5,5 +5,16 @@ 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 diff --git a/src/XMPPAuthenticator.h b/src/XMPPAuthenticator.h index 72b7e69..06ee018 100644 --- a/src/XMPPAuthenticator.h +++ b/src/XMPPAuthenticator.h @@ -27,11 +27,9 @@ */ @interface XMPPAuthenticator: OFObject { -/// \cond internal OFString *_authzid; OFString *_authcid; OFString *_password; -/// \endcond } #ifdef OF_HAVE_PROPERTIES diff --git a/src/XMPPConnection.h b/src/XMPPConnection.h index 456fd9d..7b45fbf 100644 --- a/src/XMPPConnection.h +++ b/src/XMPPConnection.h @@ -116,14 +116,14 @@ */ - (void)connectionWasClosed: (XMPPConnection*)connection; -/** - * \brief This callback is called when the connection threw an exception. +/*! + * @brief This callback is called when the connection threw an exception. * - * This is only called for connections on which \ref handleConnection: has been - * called. + * 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 + * @param connection The connection which threw an exception + * @param exception The exception the connection threw */ - (void)connection: (XMPPConnection*)connection didThrowException: (OFException*)exception; @@ -152,7 +152,6 @@ #endif { -/// \cond internal id _socket; OFXMLParser *_parser, *_oldParser; OFXMLElementBuilder *_elementBuilder, *_oldElementBuilder; @@ -172,7 +171,6 @@ BOOL _supportsRosterVersioning; BOOL _supportsStreamManagement; unsigned int _lastID; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @@ -314,24 +312,26 @@ */ - (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 @@ -362,7 +362,6 @@ - (BOOL)supportsRosterVersioning; - (BOOL)supportsStreamManagement; -/// \cond internal - (void)XMPP_startStream; - (void)XMPP_handleStream: (OFXMLElement*)element; - (void)XMPP_handleTLS: (OFXMLElement*)element; @@ -383,7 +382,6 @@ IQ: (XMPPIQ*)iq; - (OFString*)XMPP_IDNAToASCII: (OFString*)domain; - (XMPPMulticastDelegate*)XMPP_delegates; -/// \endcond @end @interface OFObject (XMPPConnectionDelegate) diff --git a/src/XMPPConnection.m b/src/XMPPConnection.m index 84e1e11..936886f 100644 --- a/src/XMPPConnection.m +++ b/src/XMPPConnection.m @@ -564,43 +564,43 @@ [_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 diff --git a/src/XMPPContact.h b/src/XMPPContact.h index de13a7b..4d8fee3 100644 --- a/src/XMPPContact.h +++ b/src/XMPPContact.h @@ -33,12 +33,11 @@ */ @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; @@ -55,11 +54,9 @@ - (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 diff --git a/src/XMPPContactManager.h b/src/XMPPContactManager.h index bcf3bbe..d18aed7 100644 --- a/src/XMPPContactManager.h +++ b/src/XMPPContactManager.h @@ -97,23 +97,23 @@ #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; diff --git a/src/XMPPExceptions.h b/src/XMPPExceptions.h index ed2610d..d522f9c 100644 --- a/src/XMPPExceptions.h +++ b/src/XMPPExceptions.h @@ -30,9 +30,7 @@ */ @interface XMPPException: OFException { -/// \cond internal XMPPConnection *_connection; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @@ -70,10 +68,8 @@ */ @interface XMPPStreamErrorException: XMPPException { -/// \cond internal OFString *_condition; OFString *_reason; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @@ -121,10 +117,8 @@ */ @interface XMPPStringPrepFailedException: XMPPException { -/// \cond internal OFString *_profile; OFString *_string; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @@ -171,10 +165,8 @@ */ @interface XMPPIDNATranslationFailedException: XMPPException { -/// \cond internal OFString *_operation; OFString *_string; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @@ -221,9 +213,7 @@ */ @interface XMPPAuthFailedException: XMPPException { -/// \cond internal OFString *_reason; -/// \endcond } #ifdef OF_HAVE_PROPERTIES diff --git a/src/XMPPJID.h b/src/XMPPJID.h index 8f0ed4f..b250c00 100644 --- a/src/XMPPJID.h +++ b/src/XMPPJID.h @@ -28,11 +28,9 @@ */ @interface XMPPJID: OFObject { -/// \cond internal OFString *_node; OFString *_domain; OFString *_resource; -/// \endcond } #ifdef OF_HAVE_PROPERTIES diff --git a/src/XMPPMulticastDelegate.h b/src/XMPPMulticastDelegate.h index 5539ab9..c7dbbc8 100644 --- a/src/XMPPMulticastDelegate.h +++ b/src/XMPPMulticastDelegate.h @@ -29,9 +29,7 @@ */ @interface XMPPMulticastDelegate: OFObject { -/// \cond internal OFDataArray *_delegates; -/// \endcond } /** diff --git a/src/XMPPPresence.h b/src/XMPPPresence.h index 1664c21..1bb1d00 100644 --- a/src/XMPPPresence.h +++ b/src/XMPPPresence.h @@ -28,11 +28,9 @@ */ @interface XMPPPresence: XMPPStanza { -/// \cond internal OFString *_status; OFString *_show; OFNumber *_priority; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @property (copy) OFString *status; diff --git a/src/XMPPRoster.h b/src/XMPPRoster.h index 75f2187..fd16c33 100644 --- a/src/XMPPRoster.h +++ b/src/XMPPRoster.h @@ -68,13 +68,11 @@ #endif { -/// \cond internal XMPPConnection *_connection; OFMutableDictionary *_rosterItems; XMPPMulticastDelegate *_delegates; id _dataStorage; BOOL _rosterRequested; -/// \endcond } #ifdef OF_HAVE_PROPERTIES @@ -153,12 +151,10 @@ - (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) diff --git a/src/XMPPRosterItem.h b/src/XMPPRosterItem.h index ee8d4f0..8cb2dea 100644 --- a/src/XMPPRosterItem.h +++ b/src/XMPPRosterItem.h @@ -29,12 +29,10 @@ */ @interface XMPPRosterItem: OFObject { -/// \cond internal XMPPJID *_JID; OFString *_name; OFString *_subscription; OFArray *_groups; -/// \endcond } #ifdef OF_HAVE_PROPERTIES diff --git a/src/XMPPSCRAMAuth.h b/src/XMPPSCRAMAuth.h index d6ab7f5..bc1df64 100644 --- a/src/XMPPSCRAMAuth.h +++ b/src/XMPPSCRAMAuth.h @@ -29,7 +29,6 @@ */ @interface XMPPSCRAMAuth: XMPPAuthenticator { -/// \cond internal Class _hashType; OFString *_cNonce; OFString *_GS2Header; @@ -38,7 +37,6 @@ XMPPConnection *_connection; BOOL _plusAvailable; BOOL _authenticated; -/// \endcond } /** diff --git a/src/XMPPSRVLookup.h b/src/XMPPSRVLookup.h index bae467e..924c325 100644 --- a/src/XMPPSRVLookup.h +++ b/src/XMPPSRVLookup.h @@ -76,10 +76,9 @@ + lookupWithDomain: (OFString*)domain; - initWithDomain: (OFString*)domain; -/// \cond internal + - (void)XMPP_lookup; - (void)XMPP_addEntry: (XMPPSRVEntry*)item; -/// \endcond @end @interface XMPPSRVEnumerator: OFEnumerator diff --git a/src/XMPPStanza.h b/src/XMPPStanza.h index c1c92a0..22f1faa 100644 --- a/src/XMPPStanza.h +++ b/src/XMPPStanza.h @@ -30,13 +30,11 @@ */ @interface XMPPStanza: OFXMLElement { -/// \cond internal XMPPJID *_from; XMPPJID *_to; OFString *_type; OFString *_ID; OFString *_language; -/// \endcond } #ifdef OF_HAVE_PROPERTIES diff --git a/src/XMPPStreamManagement.h b/src/XMPPStreamManagement.h index 85a8b50..8947073 100644 --- a/src/XMPPStreamManagement.h +++ b/src/XMPPStreamManagement.h @@ -27,10 +27,8 @@ #endif { -/// \cond internal XMPPConnection *_connection; uint32_t receivedCount; -/// \endcond } - initWithConnection: (XMPPConnection*)connection;