update docs to reference swift > objc (#9279)

Author: elenadoty

Crashlytics/Crashlytics/Components/FIRCLSApplication.h

@@ -48,7 +48,7 @@ NSString* FIRCLSApplicationGetSDKBundleID(void);
 NSString* FIRCLSApplicationGetPlatform(void);
 
 /**
- * Returns the Operating System for filtering. Should be kept consistent with Analytics.
+ * Returns the operating system for filtering. Should be kept consistent with Analytics.
  */
 NSString* FIRCLSApplicationGetFirebasePlatform(void);
 

Crashlytics/Crashlytics/Controllers/FIRCLSExistingReportManager.h

@@ -34,8 +34,8 @@ FOUNDATION_EXPORT NSUInteger const FIRCLSMaxUnsentReports;
  * been cleared for upload, so there isn't any point in asking for permission
  * or possibly spamming end-users if a report gets stuck.
  *
- * The tricky part is, customers will NOT be alerted in checkForUnsentReports
- * for reports in these paths, but when they choose sendUnsentReports / enable data
+ * The tricky part is, customers will NOT be alerted in `checkForUnsentReports`
+ * for reports in these paths, but when they choose `sendUnsentReports` / enable data
  * collection, reports in those directories will be re-managed. This should be ok and
  * just an edge case because reports should only be in processing or prepared for a split second as
  * they do on-device symbolication and get converted into a GDTEvent. After a report is handed off
@@ -44,10 +44,10 @@ FOUNDATION_EXPORT NSUInteger const FIRCLSMaxUnsentReports;
 @property(nonatomic, readonly) NSUInteger unsentReportsCount;
 
 /**
- * This value needs to stay in sync with numUnsentReports, so if there is > 0 numUnsentReports,
- * newestUnsentReport needs to return a value. Otherwise it needs to return null.
+ * This value needs to stay in sync with `numUnsentReports`, so if there is > 0 `numUnsentReports`,
+ * `newestUnsentReport` needs to return a value. Otherwise it needs to return nil.
  *
- * FIRCLSContext needs to be initialized before the FIRCrashlyticsReport is instantiated.
+ * `FIRCLSContext` needs to be initialized before the `CrashlyticsReport` is instantiated.
  */
 @property(nonatomic, readonly) FIRCrashlyticsReport *_Nullable newestUnsentReport;
 
@@ -60,7 +60,7 @@ FOUNDATION_EXPORT NSUInteger const FIRCLSMaxUnsentReports;
 /**
  * This is important to call once, early in startup, before the
  * new report for this run of the app has been created. Any
- * reports in ExistingReportManager will be uploaded or deleted
+ * reports in `ExistingReportManager` will be uploaded or deleted
  * and we don't want to do that for the current run of the app.
  *
  * If there are over MAX_UNSENT_REPORTS valid reports, this will delete them.
@@ -70,7 +70,7 @@ FOUNDATION_EXPORT NSUInteger const FIRCLSMaxUnsentReports;
 - (void)collectExistingReports;
 
 /**
- * This is the side-effect of calling deleteUnsentReports, or collect_reports setting
+ * This is the side-effect of calling `deleteUnsentReports`, or collect_reports setting
  * being false.
  */
 - (void)deleteUnsentReports;

Crashlytics/Crashlytics/Controllers/FIRCLSManagerData.h

@@ -28,14 +28,14 @@ NS_ASSUME_NONNULL_BEGIN
 @protocol FIRAnalyticsInterop;
 
 /*
- * Manager Data's purpose is to simplify the adding and removing of
+ * FIRCLSManagerData's purpose is to simplify the adding and removing of
  * dependencies from each of the Manager classes so that it's easier
  * to inject mock classes during testing. A lot of the Manager classes
  * share these dependencies, but don't use all of them.
  *
  * If you plan on adding interdependencies between Managers, do not add a pointer
  * to the dependency here. Instead add them as a new value to the constructor of
- * the Manager, and construct them in FIRCrashlytics. This data structure should
+ * the Manager, and construct them in FirebaseCrashlytics. This data structure should
  * be for Models and other SDKs / Interops Crashlytics depends on.
  */
 @interface FIRCLSManagerData : NSObject

Crashlytics/Crashlytics/Controllers/FIRCLSReportManager.m

@@ -75,7 +75,7 @@
 #endif
 
 /**
- * A FIRReportAction is used to indicate how to handle unsent reports.
+ * A FirebaseReportAction is used to indicate how to handle unsent reports.
  */
 typedef NS_ENUM(NSInteger, FIRCLSReportAction) {
   /** Upload the reports to Crashlytics. */
@@ -85,7 +85,7 @@ typedef NS_ENUM(NSInteger, FIRCLSReportAction) {
 };
 
 /**
- * This is just a helper to make code using FIRReportAction more readable.
+ * This is just a helper to make code using FirebaseReportAction more readable.
  */
 typedef NSNumber FIRCLSWrappedReportAction;
 @implementation NSNumber (FIRCLSWrappedReportAction)
@@ -203,10 +203,9 @@ - (instancetype)initWithManagerData:(FIRCLSManagerData *)managerData
   return self;
 }
 
-// This method returns a promise that is resolved with a wrapped FIRReportAction once the user has
-// indicated whether they want to upload currently cached reports.
-// This method should only be called when we have determined there is at least 1 unsent report.
-// This method waits until either:
+// This method returns a promise that is resolved with a wrapped FirebaseReportAction once the user
+// has indicated whether they want to upload currently cached reports. This method should only be
+// called when we have determined there is at least 1 unsent report. This method waits until either:
 //    1. Data collection becomes enabled, in which case, the promise will be resolved with Send.
 //    2. The developer uses the processCrashReports API to indicate whether the report
 //       should be sent or deleted, at which point the promise will be resolved with the action.

Crashlytics/Crashlytics/DataCollection/FIRCLSDataCollectionToken.h

@@ -35,8 +35,9 @@ NS_ASSUME_NONNULL_BEGIN
 + (instancetype)validToken;
 
 /**
- * Use this to verify that a token is valid. If this is called on a nil instance, it will return NO.
- * @return YES.
+ * Use this to verify that a token is valid. If this is called on a nil instance, it will return
+ * false.
+ * @return true.
  */
 - (BOOL)isValid;
 

Crashlytics/Crashlytics/FIRCLSUserDefaults/FIRCLSUserDefaults.m

@@ -32,12 +32,12 @@
 NSString *const FIRCLSUserDefaultsPathComponent = @"CLSUserDefaults";
 
 /**
- * This class is an isolated re-implementation of NSUserDefaults which isolates our storage
+ * This class is an isolated re-implementation of UserDefaults which isolates our storage
  * from that of our customers. This solves a number of issues we have seen in production, firstly
- * that customers often delete or clear NSUserDefaults, unintentionally deleting our data.
- * Further, we have seen thread safety issues in production with NSUserDefaults, as well as a number
- * of bugs related to accessing NSUserDefaults before the device has been unlocked due to the
- * NSFileProtection of NSUserDefaults.
+ * that customers often delete or clear UserDefaults, unintentionally deleting our data.
+ * Further, we have seen thread safety issues in production with UserDefaults, as well as a number
+ * of bugs related to accessing UserDefaults before the device has been unlocked due to the
+ * FileProtection of UserDefaults.
  */
 @interface FIRCLSUserDefaults ()
 @property(nonatomic, readwrite) BOOL synchronizeWroteToDisk;
@@ -308,13 +308,13 @@ - (NSDictionary *)loadDefaults {
 
 #pragma mark - migration
 
-// This method migrates all keys specified from NSUserDefaults to FIRCLSUserDefaults
+// This method migrates all keys specified from UserDefaults to FIRCLSUserDefaults
 // To do so, we copy all known key-value pairs into FIRCLSUserDefaults, synchronize it, then
-// remove the keys from NSUserDefaults and synchronize it.
+// remove the keys from UserDefaults and synchronize it.
 - (void)migrateFromNSUserDefaults:(NSArray *)keysToMigrate {
   BOOL didFindKeys = NO;
 
-  // First, copy all of the keysToMigrate which are stored NSUserDefaults
+  // First, copy all of the keysToMigrate which are stored UserDefaults
   for (NSString *key in keysToMigrate) {
     id oldValue = [[NSUserDefaults standardUserDefaults] objectForKey:(NSString *)key];
     if (nil != oldValue) {
@@ -324,22 +324,22 @@ - (void)migrateFromNSUserDefaults:(NSArray *)keysToMigrate {
   }
 
   if (didFindKeys) {
-    // First synchronize FIRCLSUserDefaults such that all keysToMigrate in NSUserDefaults are stored
+    // First synchronize FIRCLSUserDefaults such that all keysToMigrate in UserDefaults are stored
     // in FIRCLSUserDefaults. At this point, data is duplicated.
     [[FIRCLSUserDefaults standardUserDefaults] synchronize];
 
     for (NSString *key in keysToMigrate) {
       [[NSUserDefaults standardUserDefaults] removeObjectForKey:(NSString *)key];
     }
 
-    // This should be our last interaction with NSUserDefaults. All data is migrated into
+    // This should be our last interaction with UserDefaults. All data is migrated into
     // FIRCLSUserDefaults
     [[NSUserDefaults standardUserDefaults] synchronize];
   }
 }
 
 // This method first queries FIRCLSUserDefaults to see if the key exist, and upon failure,
-// searches for the key in NSUserDefaults, and migrates it if found.
+// searches for the key in UserDefaults, and migrates it if found.
 - (id)objectForKeyByMigratingFromNSUserDefaults:(NSString *)keyToMigrateOrNil {
   if (!keyToMigrateOrNil) {
     return nil;
@@ -353,10 +353,10 @@ - (id)objectForKeyByMigratingFromNSUserDefaults:(NSString *)keyToMigrateOrNil {
   id oldNSUserDefaultsValue =
       [[NSUserDefaults standardUserDefaults] objectForKey:keyToMigrateOrNil];
   if (!oldNSUserDefaultsValue) {
-    return nil;  // if the value also does not exist in NSUserDefaults, return nil.
+    return nil;  // if the value also does not exist in UserDefaults, return nil.
   }
 
-  // Otherwise, the key exists in NSUserDefaults. Migrate it to FIRCLSUserDefaults
+  // Otherwise, the key exists in UserDefaults. Migrate it to FIRCLSUserDefaults
   // and then return the associated value.
 
   // First store it in FIRCLSUserDefaults so in the event of a crash, data is not lost.

Crashlytics/Crashlytics/Helpers/FIRCLSCallStackTree.h

@@ -23,7 +23,7 @@
 #import <MetricKit/MetricKit.h>
 
 /*
- * Helper class for parsing the MXCallStackTree that we receive from MetricKit. Flattens the
+ * Helper class for parsing the `MXCallStackTree` that we receive from MetricKit. Flattens the
  * nested structure into a structure similar to what is used in Crashlytics.
  */
 @interface FIRCLSCallStackTree : NSObject

Crashlytics/Crashlytics/Helpers/FIRCLSUtility.m

@@ -136,18 +136,6 @@ bool FIRCLSUnlinkIfExists(const char* path) {
   return true;
 }
 
-/*
-NSString* FIRCLSGenerateUUID(void) {
-  NSString* string;
-
-  CFUUIDRef uuid = CFUUIDCreate(kCFAllocatorDefault);
-  string = CFBridgingRelease(CFUUIDCreateString(kCFAllocatorDefault, uuid));
-  CFRelease(uuid);
-
-  return string;
-}
-*/
-
 NSString* FIRCLSNormalizeUUID(NSString* value) {
   return [[value stringByReplacingOccurrencesOfString:@"-" withString:@""] lowercaseString];
 }
@@ -213,21 +201,6 @@ void FIRCLSRedactUUID(char* value) {
   return string;
 }
 
-/*
-NSString* FIRCLSHashBytes(const void* bytes, size_t length) {
-  uint8_t digest[CC_SHA1_DIGEST_LENGTH] = {0};
-  CC_SHA1(bytes, (CC_LONG)length, digest);
-
-  NSData* result = [NSData dataWithBytes:digest length:CC_SHA1_DIGEST_LENGTH];
-
-  return FIRCLSNSDataToNSString(result);
-}
-
-NSString* FIRCLSHashNSData(NSData* data) {
-  return FIRCLSHashBytes([data bytes], [data length]);
-}
-*/
-
 void FIRCLSAddOperationAfter(float timeInSeconds, NSOperationQueue* queue, void (^block)(void)) {
   dispatch_queue_t afterQueue = dispatch_get_global_queue(DISPATCH_QUEUE_PRIORITY_DEFAULT, 0);
   FIRCLSDispatchAfter(timeInSeconds, afterQueue, ^{

Crashlytics/Crashlytics/Models/FIRCLSInternalReport.h

@@ -74,7 +74,7 @@ extern NSString *const FIRCLSReportUserCompactedKVFile;
 @property(nonatomic, copy, readonly) NSString *installID;
 
 /**
- * Returns YES if report contains a signal, mach exception or unhandled exception record, NO
+ * Returns true if report contains a signal, mach exception or unhandled exception record, false
  * otherwise.
  **/
 @property(nonatomic, assign, readonly) BOOL isCrash;

Crashlytics/Crashlytics/Models/Record/FIRCLSRecordBase.h

@@ -25,7 +25,7 @@
 @interface FIRCLSRecordBase : NSObject
 
 /**
- * Mark the default initializer as unavailable so  the subclasses do not have to add the same line
+ * Mark the default initializer as unavailable so the subclasses do not have to add the same line
  **/
 - (instancetype)init NS_UNAVAILABLE;