Permalink
Browse files

Merge pull request #10 from jparise/header-comments

Improving some header file comment blocks.
  • Loading branch information...
2 parents e8f45d7 + 72fdbbe commit e3736a35813135a7f9aa16123dc11727ac6fdb51 @soffes soffes committed Sep 4, 2012
Showing with 13 additions and 13 deletions.
  1. +13 −13 SSKeychain.h
View
@@ -94,7 +94,7 @@ extern NSString *const kSSKeychainWhereKey;
See the `NSString` constants declared in SSKeychain.h for a list of keys that can be used when accessing the
dictionaries returned by this method.
- @return An array of dictionarires containing the Keychain's accounts, or `nil` if the Keychain doesn't have any
+ @return An array of dictionaries containing the Keychain's accounts, or `nil` if the Keychain doesn't have any
accounts. The order of the objects in the array isn't defined.
@see allAccounts:
@@ -110,7 +110,7 @@ extern NSString *const kSSKeychainWhereKey;
@param error If accessing the accounts fails, upon return contains an error that describes the problem.
- @return An array of dictionarires containing the Keychain's accounts, or `nil` if the Keychain doesn't have any
+ @return An array of dictionaries containing the Keychain's accounts, or `nil` if the Keychain doesn't have any
accounts. The order of the objects in the array isn't defined.
@see allAccounts
@@ -126,7 +126,7 @@ extern NSString *const kSSKeychainWhereKey;
@param serviceName The service for which to return the corresponding accounts.
- @return An array of dictionarires containing the Keychain's accountsfor a given `serviceName`, or `nil` if the Keychain
+ @return An array of dictionaries containing the Keychain's accountsfor a given `serviceName`, or `nil` if the Keychain
doesn't have any accounts for the given `serviceName`. The order of the objects in the array isn't defined.
@see accountsForService:error:
@@ -141,7 +141,7 @@ extern NSString *const kSSKeychainWhereKey;
@param error If accessing the accounts fails, upon return contains an error that describes the problem.
- @return An array of dictionarires containing the Keychain's accountsfor a given `serviceName`, or `nil` if the Keychain
+ @return An array of dictionaries containing the Keychain's accountsfor a given `serviceName`, or `nil` if the Keychain
doesn't have any accounts for the given `serviceName`. The order of the objects in the array isn't defined.
@see accountsForService:
@@ -154,22 +154,22 @@ extern NSString *const kSSKeychainWhereKey;
///------------------------
/**
- Returns a string containing the password for a given accounts and service, or `nil` if the Keychain doesn't have a
+ Returns a string containing the password for a given account and service, or `nil` if the Keychain doesn't have a
password for the given parameters.
@param serviceName The service for which to return the corresponding password.
@param account The account for which to return the corresponding password.
- @return Returns a string containing the password for a given accounts and service, or `nil` if the Keychain doesn't
+ @return Returns a string containing the password for a given account and service, or `nil` if the Keychain doesn't
have a password for the given parameters.
@see passwordForService:account:error:
*/
+ (NSString *)passwordForService:(NSString *)serviceName account:(NSString *)account;
/**
- Returns a string containing the password for a given accounts and service, or `nil` if the Keychain doesn't have a
+ Returns a string containing the password for a given account and service, or `nil` if the Keychain doesn't have a
password for the given parameters.
@param serviceName The service for which to return the corresponding password.
@@ -178,15 +178,15 @@ extern NSString *const kSSKeychainWhereKey;
@param error If accessing the password fails, upon return contains an error that describes the problem.
- @return Returns a string containing the password for a given accounts and service, or `nil` if the Keychain doesn't
+ @return Returns a string containing the password for a given account and service, or `nil` if the Keychain doesn't
have a password for the given parameters.
@see passwordForService:account:
*/
+ (NSString *)passwordForService:(NSString *)serviceName account:(NSString *)account error:(NSError **)error;
/**
- Returns the password data for a given accounts and service, or `nil` if the Keychain doesn't have data
+ Returns the password data for a given account and service, or `nil` if the Keychain doesn't have data
for the given parameters.
@param serviceName The service for which to return the corresponding password.
@@ -195,15 +195,15 @@ extern NSString *const kSSKeychainWhereKey;
@param error If accessing the password fails, upon return contains an error that describes the problem.
- @return Returns a string containing the password for a given accounts and service, or `nil` if the Keychain doesn't
- have a password for the given parameters.
+ @return Returns a the password data for the given account and service, or `nil` if the Keychain doesn't
+ have data for the given parameters.
@see passwordDataForService:account:error:
*/
+ (NSData *)passwordDataForService:(NSString *)serviceName account:(NSString *)account;
/**
- Returns the password data for a given accounts and service, or `nil` if the Keychain doesn't have data
+ Returns the password data for a given account and service, or `nil` if the Keychain doesn't have data
for the given parameters.
@param serviceName The service for which to return the corresponding password.
@@ -212,7 +212,7 @@ extern NSString *const kSSKeychainWhereKey;
@param error If accessing the password fails, upon return contains an error that describes the problem.
- @return Returns a string containing the password for a given accounts and service, or `nil` if the Keychain doesn't
+ @return Returns a the password data for the given account and service, or `nil` if the Keychain doesn't
have a password for the given parameters.
@see passwordDataForService:account:

0 comments on commit e3736a3

Please sign in to comment.