chore: apply pr review comments

AndrewAminInstabug · AndrewAminInstabug · commit 5fe801d8c4e2 · 2025-02-20T12:45:08.000+02:00
diff --git a/ios/RNInstabug/InstabugAPMBridge.m b/ios/RNInstabug/InstabugAPMBridge.m
@@ -36,54 +36,33 @@ - (id) init
     return self;
 }
 
-// This method is exporting a method
-// named `ibgSleep` to be accessible from JavaScript side. When this method is
-// called from JavaScript, it (sleeps) the current thread for 3 seconds.
+// Pauses the current thread for 3 seconds.
 RCT_EXPORT_METHOD(ibgSleep) {
     [NSThread sleepForTimeInterval:3.0f];
 }
 
 // Enables or disables APM.
-//
-// This function is exporting a method named
-// `setEnabled` to be accessible from JavaScript side. When this method is
-// called from JavaScript, it will set the `enabled` property of the `IBGAPM` class provided by the
-// Instabug SDK to the value passed as the `isEnabled` parameter. This property controls whether the
-// APM (Application Performance Monitoring) feature of Instabug is enabled or disabled based on the
-// boolean value passed to it.
 RCT_EXPORT_METHOD(setEnabled:(BOOL)isEnabled) {
     IBGAPM.enabled = isEnabled;
 }
 
-// This function is exporting a method named
-// `setAppLaunchEnabled` to be accessible from JavaScript side. When this
-// method is called from JavaScript, it will set the `coldAppLaunchEnabled` property of the `IBGAPM`
-// class provided by the Instabug SDK to the value passed as the `isEnabled` parameter.
+// Determines either coldAppLaunch is enabled or not.
 RCT_EXPORT_METHOD(setAppLaunchEnabled:(BOOL)isEnabled) {
     IBGAPM.coldAppLaunchEnabled = isEnabled;
 }
 
-// This function is exporting a method named `endAppLaunch` to be
-// accessible from JavaScript side. When this method is called from
-// JavaScript, it will invoke the `endAppLaunch` method from the `IBGAPM` class provided by the
-// Instabug SDK. This method is used to signal the end of the app launch process.
+// This method is used to signal the end of the app launch process.
 RCT_EXPORT_METHOD(endAppLaunch) {
     [IBGAPM endAppLaunch];
 }
 
-// This function is exporting a method named
-// `setAutoUITraceEnabled` to be accessible from JavaScript side. When this
-// method is called from JavaScript, it will set the `autoUITraceEnabled` property of the `IBGAPM`
-// class provided by the Instabug SDK to the value passed as the `isEnabled` parameter. This property
-// controls whether automatic tracing of UI interactions is enabled or disabled within the SDK. By
-// toggling this property, you can control whether the SDK captures data related to user interface
-// performance and behavior automatically.
+// Controls whether automatic tracing of UI interactions is enabled or disabled within the SDK.
 RCT_EXPORT_METHOD(setAutoUITraceEnabled:(BOOL)isEnabled) {
     IBGAPM.autoUITraceEnabled = isEnabled;
 }
 
-// This method `startExecutionTrace` is exporting a function to be accessible from JavaScript in a
-// React Native application.
+// Starts new execution trace with the specified `name`.
+//
 // Deprecated see [startFlow: (NSString *)name]
 RCT_EXPORT_METHOD(startExecutionTrace:(NSString *)name :(NSString *)id
                                      :(RCTPromiseResolveBlock)resolve
@@ -97,7 +76,8 @@ - (id) init
     }
 }
 
-// This method is exporting a function to be accessible from JavaScript side.
+//  Sets a user defined attribute for the execution trace.
+//
 // Deprecated see [setFlowAttribute:(NSString *)name :(NSString *)key :(NSString *_Nullable)value]
 RCT_EXPORT_METHOD(setExecutionTraceAttribute:(NSString *)id :(NSString *)key :(NSString *)value) {
     IBGExecutionTrace *trace = [traces objectForKey:id];
@@ -106,8 +86,8 @@ - (id) init
     }
 }
 
-// This function is exporting a method named
-// `endExecutionTrace` to be accessible from JavaScript side.
+// Ends execution trace with the specified `name`.
+//
 // Deprecated see [endFlow: (NSString *)name]
 RCT_EXPORT_METHOD(endExecutionTrace:(NSString *)id) {
     IBGExecutionTrace *trace = [traces objectForKey:id];
@@ -116,45 +96,30 @@ - (id) init
     }
 }
 
-// This function is exporting a method named
-// `startFlow` to be accessible from JavaScript side. When this method is
-// called from JavaScript, it will invoke the `startFlowWithName:` method from the `IBGAPM` class
-// provided by the Instabug SDK. This method is used to start a flow trace with the specified name,
+// Starts a flow trace with the specified `name`,
 // allowing the SDK to capture and analyze the flow of execution within the application.
 RCT_EXPORT_METHOD(startFlow: (NSString *)name) {
     [IBGAPM startFlowWithName:name];
 }
 
-// This function is exporting a method named `endFlow` to
-// be accessible from JavaScript side. When this method is called from
-// JavaScript, it will invoke the `endFlowWithName:` method from the `IBGAPM` class provided by the
-// Instabug SDK. This method is used to end a flow trace with the specified name, allowing the SDK to
-// capture and analyze the flow of execution within the application.
+// Ends a flow with the specified `name`.
 RCT_EXPORT_METHOD(endFlow: (NSString *)name) {
     [IBGAPM endFlowWithName:name];
 }
 
 
-// The function is exporting a method named `setFlowAttribute` to be accessible from
-// JavaScript side. When this method is
-// called from JavaScript, it will invoke the `setAttributeForFlowWithName:` method from the `IBGAPM` class
-// provided by the Instabug SDK to set a user defined attribute for the currently active flow.
+// Sets a user defined attribute for the currently active flow.
 RCT_EXPORT_METHOD(setFlowAttribute:(NSString *)name :(NSString *)key :(NSString *_Nullable)value) {
     [IBGAPM setAttributeForFlowWithName:name key:key value:value];
 }
 
-// This function is exporting a method named
-// `startUITrace` to be accessible from JavaScript side. When this method is
-// called from JavaScript, it will invoke the `startUITraceWithName:` method from the `IBGAPM` class
-// provided by the Instabug SDK to start a new UI trace.
+// Starts a new `UITrace` with the provided `name` parameter,
+// allowing the SDK to capture and analyze the UI components within the application.
 RCT_EXPORT_METHOD(startUITrace:(NSString *)name) {
     [IBGAPM startUITraceWithName:name];
 }
 
-// This function is exporting a method named `endUITrace` to be
-// accessible from JavaScript side. When this method is called from
-// JavaScript, it will invoke the `endUITrace` method from the `IBGAPM` class provided by the Instabug
-// SDK. This method is used to terminate the currently active UI trace.
+// Terminates the currently active UI trace.
 RCT_EXPORT_METHOD(endUITrace) {
     [IBGAPM endUITrace];
 }
diff --git a/src/modules/APM.ts b/src/modules/APM.ts
@@ -24,7 +24,7 @@ export const setAppLaunchEnabled = (isEnabled: boolean) => {
 /**
  * To define when an app launch is complete,
  * such as when it's intractable, use the end app launch API.
- * You can then view this data with the automatic cold and hot app launches.
+ * You can then view this data with the automatic cold app launche.
  */
 export const endAppLaunch = () => {
   NativeAPM.endAppLaunch();
