feat: resolve #133

RollbarCocoaLumberjackLogger is code complete
rollbar · Mar 3, 2022 · b82c3fe · b82c3fe
1 parent 4f2998c
commit b82c3fe
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 5 deletions.
diff --git a/RollbarCocoaLumberjack/Package.swift b/RollbarCocoaLumberjack/Package.swift
@@ -44,10 +44,7 @@ let package = Package(
             publicHeadersPath: "include",
             cSettings: [
                 .headerSearchPath("Sources/RollbarCocoaLumberjack/**"),
-                //                .headerSearchPath("Sources/RollbarSwift"),
-                //                .headerSearchPath("Sources/RollbarSwift/include"),
-                //                .headerSearchPath("Sources/RollbarSwift/DTOs"),
-
+                //                .headerSearchPath("Sources/RollbarCocoaLumberjack/DTOs"),
                 //                .define("DEFINES_MODULE"),
             ]
         ),

diff --git a/RollbarCocoaLumberjack/README.md b/RollbarCocoaLumberjack/README.md
@@ -6,4 +6,4 @@ This SDK module implements integration of Rollbar into the popular CocoaLumberja
 So if you either already use CocoaLumberjack or you are planning to use it for your software product logging needs, 
 then you can easily integrate Rollbar into it via this module and have all or some of the logs performed via the 
 CocoaLumberjack framework redirected into a dedicated Rollbar project at www.rollbar.com and monitor the health of
-your own software product/service remotely.
+your software product/service remotely.
diff --git a/RollbarCocoaLumberjack/Sources/RollbarCocoaLumberjack/include/RollbarCocoaLumberjackLogger.h b/RollbarCocoaLumberjack/Sources/RollbarCocoaLumberjack/include/RollbarCocoaLumberjackLogger.h
@@ -4,24 +4,34 @@
 
 NS_ASSUME_NONNULL_BEGIN
 
+/// Rollbar logger for CocoaLumberjack
 @interface RollbarCocoaLumberjackLogger : DDAbstractLogger <DDLogger> {
     @private
     RollbarLogger *_rollbarLogger;
 }
 
 #pragma mark - factory methods
 
+/// Creates initialized instance of the Rollbar logger for CocoaLumberjack
+/// @param rollbarLogger a RollbarLogger to use
 + (NSObject<DDLogger> *)createWithRollbarLogger:(RollbarLogger *)rollbarLogger;
 
+/// Creates initialized instance of the Rollbar logger for CocoaLumberjack
+/// @param rollbarConfig a RollbarConfig to use
 + (NSObject<DDLogger> *)createWithRollbarConfig:(RollbarConfig *)rollbarConfig;
 
 #pragma mark - instance initializers
 
+/// Initializer
+/// @param rollbarLogger a RollbarLogger to use
 - (instancetype)initWithRollbarLogger:(RollbarLogger *)rollbarLogger
 NS_DESIGNATED_INITIALIZER;
 
+/// Initializer
+/// @param rollbarConfig a RollbarConfig to use
 - (instancetype)initWithRollbarConfig:(RollbarConfig *)rollbarConfig;
 
+/// Hides initializer
 - (instancetype)init
 NS_UNAVAILABLE;