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

Hide instance variables from the documentation.

Browse source
This commit is contained in:
Jonathan Schleifer 2012-02-03 11:43:44 +01:00
parent 2efeee1a0d
commit 643552d5d9
10 changed files with 30 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
Doxyfile
View file

@ -6,3 +6,4 @@ HTML_OUTPUT = .
GENERATE_LATEX = NO GENERATE_LATEX = NO
HIDE_UNDOC_CLASSES = YES HIDE_UNDOC_CLASSES = YES
PREDEFINED = OF_HAVE_PROPERTIES PREDEFINED = OF_HAVE_PROPERTIES
IGNORE_PREFIX = XMPP

2
src/XMPPAuthenticator.h
View file

@ -27,9 +27,11 @@
*/ */
@interface XMPPAuthenticator: OFObject @interface XMPPAuthenticator: OFObject
{ {
/// \cond internal
OFString *authzid; OFString *authzid;
OFString *authcid; OFString *authcid;
OFString *password; OFString *password;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES

2
src/XMPPConnection.h
View file

@ -135,6 +135,7 @@
<OFXMLParserDelegate, OFXMLElementBuilderDelegate> <OFXMLParserDelegate, OFXMLElementBuilderDelegate>
#endif #endif
{ {
/// \cond internal
id sock; id sock;
OFXMLParser *parser, *oldParser; OFXMLParser *parser, *oldParser;
OFXMLElementBuilder *elementBuilder, *oldElementBuilder; OFXMLElementBuilder *elementBuilder, *oldElementBuilder;
@ -150,6 +151,7 @@
BOOL needsSession; BOOL needsSession;
BOOL encryptionRequired, encrypted; BOOL encryptionRequired, encrypted;
unsigned int lastID; unsigned int lastID;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES

10
src/XMPPExceptions.h
View file

@ -30,7 +30,9 @@
*/ */
@interface XMPPException: OFException @interface XMPPException: OFException
{ {
/// \cond internal
XMPPConnection *connection; XMPPConnection *connection;
/// \end
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES
@ -68,8 +70,10 @@
*/ */
@interface XMPPStreamErrorException: XMPPException @interface XMPPStreamErrorException: XMPPException
{ {
/// \cond internal
OFString *condition; OFString *condition;
OFString *reason; OFString *reason;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES
@ -117,8 +121,10 @@
*/ */
@interface XMPPStringPrepFailedException: XMPPException @interface XMPPStringPrepFailedException: XMPPException
{ {
/// \cond internal
OFString *profile; OFString *profile;
OFString *string; OFString *string;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES
@ -165,8 +171,10 @@
*/ */
@interface XMPPIDNATranslationFailedException: XMPPException @interface XMPPIDNATranslationFailedException: XMPPException
{ {
/// \cond internal
OFString *operation; OFString *operation;
OFString *string; OFString *string;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES
@ -213,7 +221,9 @@
*/ */
@interface XMPPAuthFailedException: XMPPException @interface XMPPAuthFailedException: XMPPException
{ {
/// \cond internal
OFString *reason; OFString *reason;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES

2
src/XMPPJID.h
View file

@ -28,9 +28,11 @@
*/ */
@interface XMPPJID: OFObject <OFCopying> @interface XMPPJID: OFObject <OFCopying>
{ {
/// \cond internal
OFString *node; OFString *node;
OFString *domain; OFString *domain;
OFString *resource; OFString *resource;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES

2
src/XMPPMulticastDelegate.h
View file

@ -29,7 +29,9 @@
*/ */
@interface XMPPMulticastDelegate: OFObject @interface XMPPMulticastDelegate: OFObject
{ {
/// \cond internal
OFDataArray *delegates; OFDataArray *delegates;
/// \endcond
} }
/** /**

2
src/XMPPRoster.h
View file

@ -67,9 +67,11 @@
<XMPPConnectionDelegate> <XMPPConnectionDelegate>
#endif #endif
{ {
/// \cond internal
XMPPConnection *connection; XMPPConnection *connection;
OFMutableDictionary *rosterItems; OFMutableDictionary *rosterItems;
XMPPMulticastDelegate *delegates; XMPPMulticastDelegate *delegates;
/// \endcond
} }
/** /**

5
src/XMPPRosterItem.h
View file

@ -24,12 +24,17 @@
@class XMPPJID; @class XMPPJID;
/**
* \brief A class for representing an item in the roster.
*/
@interface XMPPRosterItem: OFObject @interface XMPPRosterItem: OFObject
{ {
/// \cond intenral
XMPPJID *JID; XMPPJID *JID;
OFString *name; OFString *name;
OFString *subscription; OFString *subscription;
OFArray *groups; OFArray *groups;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES

2
src/XMPPSCRAMAuth.h
View file

@ -29,6 +29,7 @@
*/ */
@interface XMPPSCRAMAuth: XMPPAuthenticator @interface XMPPSCRAMAuth: XMPPAuthenticator
{ {
/// \cond internal
Class hashType; Class hashType;
OFString *cNonce; OFString *cNonce;
OFString *GS2Header; OFString *GS2Header;
@ -37,6 +38,7 @@
XMPPConnection *connection; XMPPConnection *connection;
BOOL plusAvailable; BOOL plusAvailable;
BOOL authenticated; BOOL authenticated;
/// \endcond
} }
/** /**

2
src/XMPPStanza.h
View file

@ -30,10 +30,12 @@
*/ */
@interface XMPPStanza: OFXMLElement @interface XMPPStanza: OFXMLElement
{ {
/// \cond internal
XMPPJID *from; XMPPJID *from;
XMPPJID *to; XMPPJID *to;
OFString *type; OFString *type;
OFString *ID; OFString *ID;
/// \endcond
} }
#ifdef OF_HAVE_PROPERTIES #ifdef OF_HAVE_PROPERTIES