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

Change documentation style to ObjFW's style

Browse source
This commit is contained in:
Jonathan Schleifer 2017-07-23 13:57:22 +02:00
parent 631b4e1a9d
commit 8c991b50d2
No known key found for this signature in database
GPG key ID: 28D65178B37F33E3
19 changed files with 750 additions and 613 deletions
Download patch file Download diff file Expand all files Collapse all files

70
src/XMPPPresence.h
View file

@ -25,8 +25,8 @@
OF_ASSUME_NONNULL_BEGIN
/**
* \brief A class describing a presence stanza.
/*!
* @brief A class describing a presence stanza.
*/
@interface XMPPPresence: XMPPStanza <OFComparing>
{
@ -34,83 +34,83 @@ OF_ASSUME_NONNULL_BEGIN
OFNumber *_priority;
}
/**
/*!
* The value of the stanza's type attribute.
*/
@property OF_NULL_RESETTABLE_PROPERTY (nonatomic, copy) OFString *type;
/**
/*!
* The text content of the status element.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *status;
/**
/*!
* The text content of the show element of the presence stanza.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFString *show;
/**
/*!
* The numeric content of the priority element.
*/
@property OF_NULLABLE_PROPERTY (nonatomic, copy) OFNumber *priority;
/**
* \brief Creates a new autoreleased XMPPPresence.
/*!
* @brief Creates a new autoreleased XMPPPresence.
*
* \return A new autoreleased XMPPPresence
* @return A new autoreleased XMPPPresence
*/
+ (instancetype)presence;
/**
* \brief 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
* @param ID The value for the stanza's id attribute
* @return A new autoreleased XMPPPresence
*/
+ (instancetype)presenceWithID: (nullable OFString *)ID;
/**
* \brief 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
* @param type The value for the stanza's type attribute
* @return A new autoreleased XMPPPresence
*/
+ (instancetype)presenceWithType: (nullable OFString *)type;
/**
* \brief Creates a new autoreleased XMPPPresence with the specified type and
/*!
* @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
* @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
*/
+ (instancetype)presenceWithType: (nullable OFString *)type
ID: (nullable OFString *)ID;
/**
* \brief 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
* @param ID The value for the stanza's id attribute
* @return A initialized XMPPPresence
*/
- initWithID: (nullable OFString *)ID;
/**
* \brief 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
* @param type The value for the stanza's type attribute
* @return A initialized XMPPPresence
*/
- initWithType: (nullable OFString *)type;
/**
* \brief Initializes an already allocated XMPPPresence with the specified type
/*!
* @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
* @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: (nullable OFString *)type
ID: (nullable OFString *)ID;