GTCredentialProvider nullability

Author: Ben Chatelain

ObjectiveGit/GTCredential.h

@@ -17,6 +17,8 @@ typedef NS_ENUM(NSInteger, GTCredentialType) {
     GTCredentialTypeSSHCustom = GIT_CREDTYPE_SSH_CUSTOM,
 };
 
+NS_ASSUME_NONNULL_BEGIN
+
 @class GTCredential;
 
 /// The GTCredentialProvider acts as a proxy for GTCredential requests.
@@ -29,6 +31,7 @@ typedef NS_ENUM(NSInteger, GTCredentialType) {
 /// Creates a provider from a block.
 ///
 /// credentialBlock - a block that will be called when credentials are requested.
+///                   Must not be nil.
 + (instancetype)providerWithBlock:(GTCredential *(^)(GTCredentialType type, NSString *URL, NSString *userName))credentialBlock;
 
 /// Default credential provider method.
@@ -43,7 +46,7 @@ typedef NS_ENUM(NSInteger, GTCredentialType) {
 /// type     - the credential types allowed by the operation.
 /// URL      - the URL the operation is authenticating against.
 /// userName - the user name provided by the operation. Can be nil, and might be ignored.
-- (GTCredential *)credentialForType:(GTCredentialType)type URL:(NSString *)URL userName:(NSString *)userName;
+- (GTCredential *)credentialForType:(GTCredentialType)type URL:(NSString *)URL userName:(nullable NSString *)userName;
 @end
 
 /// The GTCredential class is used to provide authentication data.
@@ -57,21 +60,23 @@ typedef NS_ENUM(NSInteger, GTCredentialType) {
 /// error    - If not NULL, set to any errors that occur.
 ///
 /// Return a new GTCredential instance, or nil if an error occurred
-+ (instancetype)credentialWithUserName:(NSString *)userName password:(NSString *)password error:(NSError **)error;
++ (nullable instancetype)credentialWithUserName:(NSString *)userName password:(NSString *)password error:(NSError **)error;
 
 /// Create a credential object from a SSH keyfile
 ///
-/// userName      - The username to authenticate as.
+/// userName      - The username to authenticate as. Must not be nil.
 /// publicKeyURL  - The URL to the public key for that user.
 ///                  Can be omitted to reconstruct the public key from the private key.
-/// privateKeyURL - The URL to the private key for that user.
+/// privateKeyURL - The URL to the private key for that user. Must not be nil.
 /// passphrase    - The passPhrase for the private key. Optional if the private key has no password.
 /// error         - If not NULL, set to any errors that occur.
 ///
 /// Return a new GTCredential instance, or nil if an error occurred
-+ (instancetype)credentialWithUserName:(NSString *)userName publicKeyURL:(NSURL *)publicKeyURL privateKeyURL:(NSURL *)privateKeyURL passphrase:(NSString *)passphrase error:(NSError **)error;
++ (nullable instancetype)credentialWithUserName:(NSString *)userName publicKeyURL:(nullable NSURL *)publicKeyURL privateKeyURL:(NSURL *)privateKeyURL passphrase:(nullable NSString *)passphrase error:(NSError **)error;
 
 /// The underlying `git_cred` object.
 - (git_cred *)git_cred __attribute__((objc_returns_inner_pointer));
 
 @end
+
+NS_ASSUME_NONNULL_END

ObjectiveGit/GTCredential.m

@@ -19,6 +19,7 @@ @interface GTCredentialProvider ()
 @end
 
 @implementation GTCredentialProvider
+
 + (instancetype)providerWithBlock:(GTCredentialProviderBlock)credentialBlock {
 	NSParameterAssert(credentialBlock != nil);