Merge pull request #128 from WideSpectrumComputing/GH-ref-#127

Update RollbarNotifier public API doc comments so they are properly rendered by Xcode Quick Help
rollbar · Feb 22, 2022 · 1b3c259 · 1b3c259
2 parents faaf3fb + e8cdeed
commit 1b3c259
Show file tree

Hide file tree

Showing 97 changed files with 1,006 additions and 1,018 deletions.
diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarAppLanguage.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarAppLanguage.m
@@ -1,11 +1,3 @@
-//
-//  RollbarAppLanguage.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-16.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarAppLanguage.h"
 
 @implementation RollbarAppLanguageUtil

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarBody.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarBody.m
@@ -1,11 +1,3 @@
-//
-//  RollbarBody.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-11-27.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarBody.h"
 
 #import "RollbarMessage.h"

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCallStackFrame.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCallStackFrame.m
@@ -1,13 +1,4 @@
-//
-//  RollbarCallStackFrame.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-11-27.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarCallStackFrame.h"
-//@import RollbarCommon;
 #import "RollbarCallStackFrameContext.h"
 
 static NSString * const DFK_FILENAME = @"filename";

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCallStackFrameContext.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCallStackFrameContext.m
@@ -1,13 +1,4 @@
-//
-//  RollbarCallStackFrameContext.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-10.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarCallStackFrameContext.h"
-//@import RollbarCommon;
 
 static NSString * const DFK_PRE_CODE_LINES = @"pre";
 static NSString * const DFK_POST_CODE_LINES = @"post";

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCaptureIpType.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCaptureIpType.m
@@ -1,11 +1,3 @@
-//
-//  CaptureIpType.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-15.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarCaptureIpType.h"
 
 @implementation RollbarCaptureIpTypeUtil

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarClient.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarClient.m
@@ -1,13 +1,4 @@
-//
-//  RollbarClient.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-02.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarClient.h"
-//@import RollbarCommon;
 #import "RollbarJavascript.h"
 
 #pragma mark - data field keys

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarConfig.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarConfig.m
@@ -1,11 +1,3 @@
-//
-//  RollbarConfig.m
-//  RollbarNotifier
-//
-//  Created by Andrey Kornich on 2019-10-11.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarConfig.h"
 #import "RollbarCachesDirectory.h"
 #import "RollbarDestination.h"

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCrashReport.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarCrashReport.m
@@ -1,13 +1,4 @@
-//
-//  RollbarCrashReport.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-11-27.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarCrashReport.h"
-//@import RollbarCommon;
 #import <Foundation/Foundation.h>
 
 static NSString * const DFK_RAW = @"raw";

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarData.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarData.m
@@ -1,21 +1,10 @@
-//
-//  RollbarData.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-10.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarData.h"
-//#import "DataTransferObject.h"
-//#import "DataTransferObject+Protected.h"
 #import "RollbarBody.h"
 #import "RollbarRequest.h"
 #import "RollbarPerson.h"
 #import "RollbarServer.h"
 #import "RollbarClient.h"
 #import "RollbarModule.h"
-//#import "JSONSupport.h"
 
 #pragma mark - data field keys
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarDestination.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarDestination.m
@@ -1,13 +1,4 @@
-//
-//  RollbarDestination.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-23.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarDestination.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarDeveloperOptions.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarDeveloperOptions.m
@@ -1,13 +1,4 @@
-//
-//  RollbarDeveloperOptions.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-23.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarDeveloperOptions.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarException.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarException.m
@@ -1,13 +1,4 @@
-//
-//  RollbarException.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-11-27.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarException.h"
-//#import "DataTransferObject+Protected.h"
 
 static NSString * const DFK_CLASS = @"class";
 static NSString * const DFK_MESSAGE = @"message";

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarHttpMethod.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarHttpMethod.m
@@ -1,11 +1,3 @@
-//
-//  RollbarHttpMethod.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-02.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarHttpMethod.h"
 
 @implementation RollbarHttpMethodUtil

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarJavascript.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarJavascript.m
@@ -1,14 +1,4 @@
-//
-//  RollbarJavascript.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-02.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarJavascript.h"
-//#import "DataTransferObject+Protected.h"
-//#import "TriStateFlag.h"
 
 #pragma mark - data field keys
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarLevel.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarLevel.m
@@ -1,5 +1,3 @@
-//  Copyright © 2018 Rollbar. All rights reserved.
-
 #import "RollbarLevel.h"
 
 @implementation RollbarLevelUtil

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarLoggingOptions.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarLoggingOptions.m
@@ -1,13 +1,4 @@
-//
-//  RollbarLoggingOptions.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-28.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarLoggingOptions.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarMessage.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarMessage.m
@@ -1,14 +1,4 @@
-//
-//  RollbarMessage.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-11-27.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarMessage.h"
-//#import "DataTransferObject.h"
-//#import "DataTransferObject+Protected.h"
 #import <Foundation/Foundation.h>
 
 static NSString * const DFK_BODY = @"body";

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarModule.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarModule.m
@@ -1,13 +1,4 @@
-//
-//  RollbarModule.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-25.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarModule.h"
-//@import RollbarCommon;
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarPayload.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarPayload.m
@@ -1,13 +1,4 @@
-//
-//  RollbarPayload.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-08.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarPayload.h"
-//#import "DataTransferObject+Protected.h"
 #import "RollbarData.h"
 
 #pragma mark - data field keys

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarPerson.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarPerson.m
@@ -1,13 +1,4 @@
-//
-//  RollbarPerson.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-25.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarPerson.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarProxy.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarProxy.m
@@ -1,14 +1,5 @@
-//
-//  RollbarProxy.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-24.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import <Foundation/Foundation.h>
 #import "RollbarProxy.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarRequest.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarRequest.m
@@ -1,13 +1,4 @@
-//
-//  RollbarRequest.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-02.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarRequest.h"
-//#import "DataTransferObject+Protected.h"
 
 static NSString * const DFK_URL = @"url";
 static NSString * const DFK_METHOD = @"method";

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarScrubbingOptions.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarScrubbingOptions.m
@@ -1,13 +1,4 @@
-//
-//  RollbarScrubbingOptions.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-24.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarScrubbingOptions.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarServer.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarServer.m
@@ -1,13 +1,4 @@
-//
-//  RollbarServer.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-12-02.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarServer.h"
-//#import "DataTransferObject+Protected.h"
 
 static NSString *const DFK_CPU = @"cpu";
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarServerConfig.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarServerConfig.m
@@ -1,13 +1,4 @@
-//
-//  RollbarServer.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2019-10-24.
-//  Copyright © 2019 Rollbar. All rights reserved.
-//
-
 #import "RollbarServerConfig.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarSource.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarSource.m
@@ -1,11 +1,3 @@
-//
-//  RollbarSource.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2020-02-28.
-//  Copyright © 2020 Rollbar. All rights reserved.
-//
-
 #import "RollbarSource.h"
 
 @implementation RollbarSourceUtil

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarTelemetryBody.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarTelemetryBody.m
@@ -1,11 +1,3 @@
-//
-//  RollbarTelemetryBody.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2020-02-28.
-//  Copyright © 2020 Rollbar. All rights reserved.
-//
-
 #import "RollbarTelemetryBody.h"
 
 @implementation RollbarTelemetryBody

diff --git a/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarTelemetryConnectivityBody.m b/RollbarNotifier/Sources/RollbarNotifier/DTOs/RollbarTelemetryConnectivityBody.m
@@ -1,13 +1,4 @@
-//
-//  RollbarTelemetryConnectivityBody.m
-//  Rollbar
-//
-//  Created by Andrey Kornich on 2020-02-28.
-//  Copyright © 2020 Rollbar. All rights reserved.
-//
-
 #import "RollbarTelemetryConnectivityBody.h"
-//#import "DataTransferObject+Protected.h"
 
 #pragma mark - constants
 
@@ -37,11 +28,6 @@ -(instancetype)initWithStatus:(nonnull NSString *)status {
     return [self initWithStatus:status extraData:nil];
 }
 
-- (instancetype)initWithArray:(NSArray *)data {
-
-    return [super initWithArray:data];
-}
-
 - (instancetype)initWithDictionary:(NSDictionary<NSString *, id> *)data {
 
     return [super initWithDictionary:data];