Documentation improvements.

This commit is contained in:
Jonathan Schleifer 2012-02-03 16:12:04 +01:00
parent ed82ae1799
commit 0da29ac529
14 changed files with 153 additions and 129 deletions

View file

@ -42,7 +42,7 @@
}
/**
* Creates a new autoreleased XMPPSCRAMAuth with an authcid and password.
* \brief Creates a new autoreleased XMPPSCRAMAuth with an authcid and password.
*
* \param authcid The authcid to authenticate with
* \param password The password to authenticate with
@ -58,8 +58,8 @@
plusAvailable: (BOOL)plusAvailable;
/**
* Creates a new autoreleased XMPPSCRAMAuth with an authzid,
* authcid and password.
* \brief Creates a new autoreleased XMPPSCRAMAuth with an authzid, authcid and
* password.
*
* \param authzid The authzid to get authorization for
* \param authcid The authcid to authenticate with
@ -77,7 +77,8 @@
plusAvailable: (BOOL)plusAvailable;
/**
* Initializes an already allocated XMPPSCRAMAuth with an authcid and password.
* \brief Initializes an already allocated XMPPSCRAMAuth with an authcid and
* password.
*
* \param authcid The authcid to authenticate with
* \param password The password to authenticate with
@ -93,8 +94,8 @@
plusAvailable: (BOOL)plusAvailable;
/**
* Initializes an already allocated XMPPSCRAMAuth with a authzid,
* authcid and password.
* \brief Initializes an already allocated XMPPSCRAMAuth with a authzid,
* authcid and password.
*
* \param authzid The authzid to get authorization for
* \param authcid The authcid to authenticate with