Updating java doc (#3258)

Updating java doc. (b/171795693)

Author: eldhosembabu

firebase-inappmessaging/src/main/java/com/google/firebase/inappmessaging/FirebaseInAppMessaging.java

@@ -90,7 +90,7 @@ public class FirebaseInAppMessaging {
   }
 
   /**
-   * Get FirebaseInAppMessaging instance using the firebase app returned by {@link
+   * Gets FirebaseInAppMessaging instance using the firebase app returned by {@link
    * FirebaseApp#getInstance()}
    *
    * @param
@@ -102,7 +102,7 @@ public static FirebaseInAppMessaging getInstance() {
   }
 
   /**
-   * Determine whether automatic data collection is enabled or not
+   * Determines whether automatic data collection is enabled or not.
    *
    * @return true if auto initialization is required
    */
@@ -111,7 +111,7 @@ public boolean isAutomaticDataCollectionEnabled() {
   }
 
   /**
-   * Enable, disable or clear automatic data collection for Firebase In-App Messaging.
+   * Enables, disables, or clears automatic data collection for Firebase In-App Messaging.
    *
    * <p>When enabled, generates a registration token on app startup if there is no valid one and
    * generates a new token when it is deleted (which prevents {@link
@@ -146,7 +146,7 @@ public void setAutomaticDataCollectionEnabled(@Nullable Boolean isAutomaticColle
   }
 
   /**
-   * Enable or disable automatic data collection for Firebase In-App Messaging.
+   * Enables, disables, or clears automatic data collection for Firebase In-App Messaging.
    *
    * <p>When enabled, generates a registration token on app startup if there is no valid one and
    * generates a new token when it is deleted (which prevents {@link
@@ -172,7 +172,7 @@ public void setAutomaticDataCollectionEnabled(boolean isAutomaticCollectionEnabl
   }
 
   /**
-   * Enable or disable suppression of Firebase In App Messaging messages
+   * Enables or disables suppression of Firebase In App Messaging messages.
    *
    * <p>When enabled, no in app messages will be rendered until either you either disable
    * suppression, or the app restarts, as this state is not preserved over app restarts.
@@ -186,7 +186,7 @@ public void setMessagesSuppressed(@NonNull Boolean areMessagesSuppressed) {
   }
 
   /**
-   * Determine whether messages are suppressed or not. This is honored by the UI sdk, which handles
+   * Determines whether messages are suppressed or not. This is honored by the UI sdk, which handles
    * rendering the in app message.
    *
    * @return true if messages should be suppressed
@@ -196,8 +196,8 @@ public boolean areMessagesSuppressed() {
   }
 
   /**
-   * Called to set a new message display component for FIAM SDK. This is the method used by both the
-   * default FIAM display SDK or any app wanting to customize the message display.
+   * Sets message display component for FIAM SDK. This is the method used by both the default FIAM
+   * display SDK or any app wanting to customize the message display.
    */
   public void setMessageDisplayComponent(@NonNull FirebaseInAppMessagingDisplay messageDisplay) {
     Logging.logi("Setting display event component");
@@ -214,12 +214,8 @@ public void clearDisplayListener() {
     this.fiamDisplay = null;
   }
 
-  /*
-   * Adds/Removes the event listeners. These listeners are triggered after FIAM's internal metrics reporting, but regardless of success/failure of the FIAM-internal callbacks.
-   */
-
   /**
-   * Registers an impression listener with FIAM, which will be notified on every FIAM impression
+   * Registers an impression listener with FIAM, which will be notified on every FIAM impression.
    *
    * @param impressionListener
    */
@@ -229,7 +225,7 @@ public void addImpressionListener(
   }
 
   /**
-   * Registers a click listener with FIAM, which will be notified on every FIAM click
+   * Registers a click listener with FIAM, which will be notified on every FIAM click.
    *
    * @param clickListener
    */
@@ -238,7 +234,7 @@ public void addClickListener(@NonNull FirebaseInAppMessagingClickListener clickL
   }
 
   /**
-   * Registers a dismiss listener with FIAM, which will be notified on every FIAM dismiss
+   * Registers a dismiss listener with FIAM, which will be notified on every FIAM dismiss.
    *
    * @param dismissListener
    */
@@ -248,7 +244,7 @@ public void addDismissListener(@NonNull FirebaseInAppMessagingDismissListener di
 
   /**
    * Registers a display error listener with FIAM, which will be notified on every FIAM display
-   * error
+   * error.
    *
    * @param displayErrorListener
    */
@@ -257,11 +253,9 @@ public void addDisplayErrorListener(
     developerListenerManager.addDisplayErrorListener(displayErrorListener);
   }
 
-  // Executed with provided executor
-
   /**
    * Registers an impression listener with FIAM, which will be notified on every FIAM impression,
-   * and triggered on the provided executor
+   * and triggered on the provided executor.
    *
    * @param impressionListener
    * @param executor
@@ -274,7 +268,7 @@ public void addImpressionListener(
 
   /**
    * Registers a click listener with FIAM, which will be notified on every FIAM click, and triggered
-   * on the provided executor
+   * on the provided executor.
    *
    * @param clickListener
    * @param executor
@@ -286,7 +280,7 @@ public void addClickListener(
 
   /**
    * Registers a dismiss listener with FIAM, which will be notified on every FIAM dismiss, and
-   * triggered on the provided executor
+   * triggered on the provided executor.
    *
    * @param dismissListener
    * @param executor
@@ -298,7 +292,7 @@ public void addDismissListener(
 
   /**
    * Registers a display error listener with FIAM, which will be notified on every FIAM display
-   * error, and triggered on the provided executor
+   * error, and triggered on the provided executor.
    *
    * @param displayErrorListener
    * @param executor
@@ -309,10 +303,8 @@ public void addDisplayErrorListener(
     developerListenerManager.addDisplayErrorListener(displayErrorListener, executor);
   }
 
-  // Removing individual listeners:
-
   /**
-   * Unregisters an impression listener
+   * Unregisters an impression listener.
    *
    * @param impressionListener
    */
@@ -322,7 +314,7 @@ public void removeImpressionListener(
   }
 
   /**
-   * Unregisters a click listener
+   * Unregisters a click listener.
    *
    * @param clickListener
    */
@@ -331,7 +323,7 @@ public void removeClickListener(@NonNull FirebaseInAppMessagingClickListener cli
   }
 
   /**
-   * Unregisters a display error listener
+   * Unregisters a display error listener.
    *
    * @param displayErrorListener
    */
@@ -350,8 +342,8 @@ public void removeAllListeners() {
   }
 
   /**
-   * Programmatically trigger a contextual trigger. This will display any eligible in-app messages
-   * that are triggered by this event
+   * Programmatically triggers a contextual trigger. This will display any eligible in-app messages
+   * that are triggered by this event.
    *
    * @param eventName
    */