📝 Documentation

Author: alyezz

android/src/main/java/com/instabug/instabugflutter/InstabugFlutterPlugin.java

@@ -79,6 +79,14 @@ public void onMethodCall(MethodCall call, Result result) {
     }
   }
 
+    /**
+     * starts the SDK with the desired
+     * @param token token The token that identifies the app, you can find
+     * it on your dashboard.
+     * @param invocationEvents invocationEvents The events that invoke
+     * the SDK's UI.
+     */
+
   public void start(Application application, String token, ArrayList<String> invocationEvents) {
     InstabugInvocationEvent[] invocationEventsArray = new InstabugInvocationEvent[invocationEvents.size()];
     for (int i = 0; i < invocationEvents.size(); i++) {

ios/Classes/InstabugFlutterPlugin.m

@@ -43,7 +43,13 @@ - (void)handleMethodCall:(FlutterMethodCall*)call result:(FlutterResult)result {
     }
 }
 
-
+/**
+  * starts the SDK with the desired
+  * @param {token} token The token that identifies the app, you can find
+  * it on your dashboard.
+  * @param {invocationEvents} invocationEvents The events that invoke
+  * the SDK's UI.
+  */
 + (void)startWithToken:(NSString *)token invocationEvents:(NSArray*)invocationEventsArray {
     NSDictionary *invocationEventsMap = [self constants];
     NSInteger invocationEvents = IBGInvocationEventNone;

lib/instabug_flutter.dart

@@ -13,6 +13,16 @@ class InstabugFlutter {
     return version;
   }
 
+   /*
+   * Starts the SDK.
+   * This is the main SDK method that does all the magic. This is the only
+   * method that SHOULD be called.
+   * Should be called in constructor of the app registery component
+   * @param {string} token The token that identifies the app, you can find
+   * it on your dashboard.
+   * @param {List<InvocationEvent>} invocationEvents The events that invoke
+   * the SDK's UI.
+   */
   static void start(String token, List<InvocationEvent> invocationEvents) async {
     List<String> invocationEventsStrings = new List<String>();
     invocationEvents.forEach((e) {