diff options
author | Mikkel Krautz <mikkel@krautz.dk> | 2012-05-03 17:26:09 +0400 |
---|---|---|
committer | Mikkel Krautz <mikkel@krautz.dk> | 2012-05-03 17:26:09 +0400 |
commit | 5d9fc4f1ae35b716a1c21313a20530fbd2737a4a (patch) | |
tree | a0d78d3ba69285324c6823ad383897aa8b310265 | |
parent | 3450fac0304f4883ec3af6eaa08a327967ef6861 (diff) |
MumbleKit: documentation fixes.
-rw-r--r-- | src/MumbleKit/MKCertificate.h | 5 | ||||
-rw-r--r-- | src/MumbleKit/MKConnection.h | 2 | ||||
-rw-r--r-- | src/MumbleKit/MKServerModel.h | 2 | ||||
-rw-r--r-- | src/MumbleKit/MKTextMessage.h | 2 |
4 files changed, 8 insertions, 3 deletions
diff --git a/src/MumbleKit/MKCertificate.h b/src/MumbleKit/MKCertificate.h index 19eb270..dc00fa5 100644 --- a/src/MumbleKit/MKCertificate.h +++ b/src/MumbleKit/MKCertificate.h @@ -208,6 +208,8 @@ extern NSString *MKCertificateItemSerialNumber; * Checks whether the signature of the receiver certificate is signed by the * parentCert certificate. * + * @param parentCert A certificate that might have signed the receiver certificate. + * * @returns YES if a valid signature was found, otherwise returns NO. */ - (BOOL) isSignedBy:(MKCertificate *)parentCert; @@ -215,6 +217,9 @@ extern NSString *MKCertificateItemSerialNumber; /** * Checks whether the signature of the receiver certificate is valid on the given date. * + * @param date The date that is checked against the certificate's notBefore and + * notAfter dates. + * * @returns YES is the certificate is valid on the given date, otherwise returns NO. */ - (BOOL) isValidOnDate:(NSDate *)date; diff --git a/src/MumbleKit/MKConnection.h b/src/MumbleKit/MKConnection.h index efeda86..3f19f76 100644 --- a/src/MumbleKit/MKConnection.h +++ b/src/MumbleKit/MKConnection.h @@ -117,7 +117,7 @@ typedef enum { /** * This method is called if a connection cannot be stablished to the given server. * - @ @param conn The connection that this occurred in. + * @param conn The connection that this occurred in. * @param err Error describing why the connection could not be established. */ - (void) connection:(MKConnection *)conn unableToConnectWithError:(NSError *)err; diff --git a/src/MumbleKit/MKServerModel.h b/src/MumbleKit/MKServerModel.h index 2b28541..d06c366 100644 --- a/src/MumbleKit/MKServerModel.h +++ b/src/MumbleKit/MKServerModel.h @@ -665,7 +665,7 @@ typedef enum { * channels in this array. * * @param users An NSArray of MKUser objects (or nil). - @ + * */ - (void) sendTextMessage:(MKTextMessage *)txtMsg toTreeChannels:(NSArray *)trees andChannels:(NSArray *)channels andUsers:(NSArray *)users; diff --git a/src/MumbleKit/MKTextMessage.h b/src/MumbleKit/MKTextMessage.h index fabfd14..4bcf1d6 100644 --- a/src/MumbleKit/MKTextMessage.h +++ b/src/MumbleKit/MKTextMessage.h @@ -18,7 +18,7 @@ /** * Create a new MKTextMessage with HTML representation given in html. * - * @param msg The HTML representing the text message. + * @param html The HTML representing the text message. * * @returns Returns a MKTextMessage object that can be sent using an * MKServerModel. |