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

62
src/XMPPDiscoIdentity.h
View file

@ -25,67 +25,75 @@
OF_ASSUME_NONNULL_BEGIN
/**
* \brief A class describing a Service Discovery Identity
/*!
* @brief A class describing a Service Discovery Identity
*/
@interface XMPPDiscoIdentity: OFObject <OFComparing>
{
OFString *_category, *_name, *_type;
}
/// \brief The category of the identity
/*!
* The category of the identity.
*/
@property (readonly, nonatomic) OFString *category;
/// \brief The name of the identity, might be unset
/*!
* The name of the identity, might be unset.
*/
@property (readonly, nonatomic) OFString *name;
/// \brief The type of the identity
/*!
* The type of the identity.
*/
@property (readonly, nonatomic) OFString *type;
/**
* \brief Creates a new autoreleased XMPPDiscoIdentity with the specified
/*!
* @brief Creates a new autoreleased XMPPDiscoIdentity with the specified
* category, type and name.
*
* \param category The category of the identity
* \param type The type of the identity
* \param name The name of the identity
* \return A new autoreleased XMPPDiscoIdentity
* @param category The category of the identity
* @param type The type of the identity
* @param name The name of the identity
* @return A new autoreleased XMPPDiscoIdentity
*/
+ (instancetype)identityWithCategory: (OFString *)category
type: (OFString *)type
name: (nullable OFString *)name;
/**
* \brief Creates a new autoreleased XMPPDiscoIdentity with the specified
/*!
* @brief Creates a new autoreleased XMPPDiscoIdentity with the specified
* category and type.
*
* \param category The category of the identity
* \param type The type of the identity
* \return A new autoreleased XMPPDiscoIdentity
* @param category The category of the identity
* @param type The type of the identity
* @return A new autoreleased XMPPDiscoIdentity
*/
+ (instancetype)identityWithCategory: (OFString *)category
type: (OFString *)type;
- init OF_UNAVAILABLE;
/**
* \brief Initializes an already allocated XMPPDiscoIdentity with the specified
/*!
* @brief Initializes an already allocated XMPPDiscoIdentity with the specified
* category, type and name.
*
* \param category The category of the identity
* \param type The type of the identity
* \param name The name of the identity
* \return An initialized XMPPDiscoIdentity
* @param category The category of the identity
* @param type The type of the identity
* @param name The name of the identity
* @return An initialized XMPPDiscoIdentity
*/
- initWithCategory: (OFString *)category
type: (OFString *)type
name: (nullable OFString *)name OF_DESIGNATED_INITIALIZER;
/**
* \brief Initializes an already allocated XMPPDiscoIdentity with the specified
/*!
* @brief Initializes an already allocated XMPPDiscoIdentity with the specified
* category and type.
*
* \param category The category of the identity
* \param type The type of the identity
* \return An initialized XMPPDiscoIdentity
* @param category The category of the identity
* @param type The type of the identity
* @return An initialized XMPPDiscoIdentity
*/
- initWithCategory: (OFString *)category
type: (OFString *)type;