Merge from Apple-Shared-Source.

Author: Edward Smith

Branch-SDK-Tests/Branch-SDK-Tests/BNCError.Test.m

@@ -1,27 +1,20 @@
+/**
+ @file          BNCError.Test.m
+ @package       Branch-SDK
+ @brief         Branch error tests.
 
-
-//--------------------------------------------------------------------------------------------------
-//
-//                                                                                   BNCError.Test.m
-//                                                                                       BranchTests
-//
-//                                                                                       Error Tests
-//                                                                         Edward Smith, August 2017
-//
-//                                             -©- Copyright © 2017 Branch, all rights reserved. -©-
-//
-//--------------------------------------------------------------------------------------------------
-
+ @author        Edward Smith
+ @date          August 2017
+ @copyright     Copyright © 2017 Branch. All rights reserved.
+*/
 
 #import "BNCTestCase.h"
 #import "BNCError.h"
 #import "BNCLocalization.h"
 
-
 @interface BNCErrorTest : BNCTestCase
 @end
 
-
 @implementation BNCErrorTest
 
 - (void) testErrorBasic {

Branch-SDK-Tests/Branch-SDK-Tests/BNCLocalization.Test.m

@@ -1,26 +1,19 @@
+/**
+ @file          BNCLocalization.Test.m
+ @package       Branch-SDK
+ @brief         Branch string localization tests.
 
-
-//--------------------------------------------------------------------------------------------------
-//
-//                                                                            BNCLocalization.Test.m
-//                                                                                       BranchTests
-//
-//                                                                                Localization Tests
-//                                                                           Edward Smith, July 2017
-//
-//                                             -©- Copyright © 2017 Branch, all rights reserved. -©-
-//
-//--------------------------------------------------------------------------------------------------
-
+ @author        Edward Smith
+ @date          July 2017
+ @copyright     Copyright © 2017 Branch. All rights reserved.
+*/
 
 #import "BNCTestCase.h"
 #import "BNCLocalization.h"
 
-
 @interface BNCLocalizationTest : BNCTestCase
 @end
 
-
 @implementation BNCLocalizationTest
 
 - (void) testLocalizationBasic {
@@ -37,10 +30,13 @@ - (void) testLocalizationBasic {
     string = BNCLocalizedString(truth);
     XCTAssertEqualObjects(string, truth);
 
+    #pragma clang diagnostic push
+    #pragma clang diagnostic ignored "-Wall"
     // Nil input should return empty string output.
     truth = @"";
     string = BNCLocalizedString(nil);
     XCTAssertEqualObjects(string, truth);
+    #pragma clang diagnostic pop
 
     // Test formatted language strings.
     truth = @"Test formatted language strings.";
@@ -52,9 +48,12 @@ - (void) testLocalizationBasic {
     string = BNCLocalizedFormattedString(@"Test formatted %@ strings float %1.2f.", @"language", 1.0);
     XCTAssertEqualObjects(string, truth);
 
+    #pragma clang diagnostic push
+    #pragma clang diagnostic ignored "-Wall"
     truth = @"";
     string = BNCLocalizedFormattedString(nil, 1.0);
     XCTAssertEqualObjects(string, truth);
+    #pragma clang diagnostic pop
 }
 
 - (void) testLocalizationRussian {

Branch-SDK/Branch-SDK/BNCError.h

@@ -1,10 +1,12 @@
-//
-//  BNCError.h
-//  Branch-SDK
-//
-//  Created by Qinwei Gong on 11/17/14.
-//  Copyright (c) 2014 Branch Metrics. All rights reserved.
-//
+/**
+ @file          BNCError.h
+ @package       Branch-SDK
+ @brief         Branch errors.
+
+ @author        Qinwei Gong
+ @date          November 2014
+ @copyright     Copyright © 2014 Branch. All rights reserved.
+*/
 
 #if __has_feature(modules)
 @import Foundation;
@@ -40,4 +42,5 @@ typedef NS_ENUM(NSInteger, BNCErrorCode) {
 + (NSError*_Nonnull) branchErrorWithCode:(BNCErrorCode)errorCode localizedMessage:(NSString*_Nullable)message;
 @end
 
-void BNCForceNSErrorCategoryToLoad(void) __attribute__((constructor));
+void BNCForceNSErrorCategoryToLoad(void)
+    __attribute__((constructor));

Branch-SDK/Branch-SDK/BNCError.m

@@ -1,10 +1,12 @@
-//
-//  BNCError.m
-//  Branch-SDK
-//
-//  Created by Qinwei Gong on 11/17/14.
-//  Copyright (c) 2014 Branch Metrics. All rights reserved.
-//
+/**
+ @file          BNCError.m
+ @package       Branch-SDK
+ @brief         Branch errors.
+
+ @author        Qinwei Gong
+ @date          November 2014
+ @copyright     Copyright © 2014 Branch. All rights reserved.
+*/
 
 #import "BNCError.h"
 #import "BNCLocalization.h"

Branch-SDK/Branch-SDK/BNCLocalization.h

@@ -1,32 +1,50 @@
-//
-//  BNCLocalization.h
-//  Branch-SDK
-//
-//  Created by Parth Kalavadia on 7/10/17.
-//  Copyright © 2017 Branch Metrics. All rights reserved.
-//
+/**
+ @file          BNCLocalization.h
+ @package       Branch-SDK
+ @brief         Branch string localizations.
+
+ @author        Parth Kalavadia
+ @date          July 2017
+ @copyright     Copyright © 2017 Branch. All rights reserved.
+*/
+
+/**
+    @discusion
+
+    # BNCLocalization
+
+    Since the Branch SDK can be shipped as a static library, it can't use the standard Apple
+    string localization mechanism.
+
+    Use this class to localize the few user-facing string resources the Branch SDK has.
+*/
 
 #if __has_feature(modules)
 @import Foundation;
 #else
 #import <Foundation/Foundation.h>
 #endif
 
+NS_ASSUME_NONNULL_BEGIN
+
 @interface BNCLocalization : NSObject
 
 + (instancetype) shared;
 + (NSString*) applicationLanguage;
 + (NSDictionary<NSString*, NSDictionary*>*) languageDictionaries;
 - (NSString*) localizeString:(NSString*)string;
 
+/// Set to an empty string or nil to reset the current language.
 @property (copy, atomic) NSString* currentLanguage;
 @property (strong, atomic, readonly) NSDictionary *currentLanguageDictionary;
 @end
 
 #pragma mark Convenience Functions
 
-static inline NSString* /**_Nonnull*/ BNCLocalizedString(NSString*const string) {
+static inline NSString* BNCLocalizedString(NSString*const string) {
     return [[BNCLocalization shared] localizeString:string];
 }
 
-extern NSString* /**_Nonnull*/ BNCLocalizedFormattedString(NSString*const format, ...) NS_FORMAT_FUNCTION(1,2);
+extern NSString* BNCLocalizedFormattedString(NSString*const format, ...) NS_FORMAT_FUNCTION(1,2);
+
+NS_ASSUME_NONNULL_END

Branch-SDK/Branch-SDK/BNCLocalization.m

@@ -1,10 +1,12 @@
-//
-//  BNCLocalization.m
-//  Branch-SDK
-//
-//  Created by Parth Kalavadia on 7/10/17.
-//  Copyright © 2017 Branch Metrics. All rights reserved.
-//
+/**
+ @file          BNCLocalization.m
+ @package       Branch-SDK
+ @brief         Branch string localizations.
+
+ @author        Parth Kalavadia
+ @date          July 2017
+ @copyright     Copyright © 2017 Branch. All rights reserved.
+*/
 
 #import "BNCLocalization.h"
 #import "BNCLog.h"
@@ -58,7 +60,7 @@ - (NSString*_Nonnull) currentLanguage {
     }
 }
 
-- (void) setCurrentLanguage:(NSString*_Null_unspecified)language {
+- (void) setCurrentLanguage:(NSString*)language {
     @synchronized (self) {
 
         if (!language.length) {