LIBcc40831 javadoc comments updated

Vorlonsoft · Aug 31, 2018 · ee8638e · ee8638e
1 parent 8bcde15
commit ee8638e
Show file tree

Hide file tree

Showing 2 changed files with 22 additions and 4 deletions.
diff --git a/library/src/main/java/com/vorlonsoft/android/rate/AppRate.java b/library/src/main/java/com/vorlonsoft/android/rate/AppRate.java
@@ -239,6 +239,7 @@ public AppRate setShowLaterButton(@SuppressWarnings("SameParameterValue") boolea
      * Decides if Never button appear in the rating dialog or not
      *
      * @param isShowNeverButton default is true
+     * @return AppRate singleton object
      */
     @SuppressWarnings("unused")
     public AppRate setShowNeverButton(boolean isShowNeverButton) {
@@ -345,6 +346,7 @@ public AppRate setTextNever(String negativeText) {
      * Sets whether the rating dialog is cancelable or not.
      *
      * @param cancelable default is false
+     * @return AppRate singleton object
      */
     public AppRate setCancelable(@SuppressWarnings("SameParameterValue") boolean cancelable) {
         dialogOptions.setCancelable(cancelable);
@@ -464,6 +466,7 @@ public AppRate setEventCountValue(String eventName, short countValue) {
      * Sets dialog theme. You can use a specific theme to inflate the dialog.
      *
      * @param themeResId theme resource ID, default is 0
+     * @return AppRate singleton object
      */
     @SuppressWarnings("unused")
     public AppRate setThemeResId(int themeResId) {
@@ -476,6 +479,7 @@ public AppRate setThemeResId(int themeResId) {
      *
      * @param dialogManagerFactory DialogManager.Factory object, default is
      *                             DefaultDialogManager.Factory object
+     * @return AppRate singleton object
      */
     @SuppressWarnings("unused")
     public AppRate setDialogManagerFactory(DialogManager.Factory dialogManagerFactory) {
@@ -486,8 +490,8 @@ public AppRate setDialogManagerFactory(DialogManager.Factory dialogManagerFactor
     }
 
     /**
-     * <p>Monitors app launch times.</p>
-     * <p>Call this method when the launcher activity's onCreate() is launched.</p>
+     * <p>Monitors launches of the application.</p>
+     * <p>Call this method when the {@code onCreate()} of the app's launcher activity is launched.</p>     *
      */
     public void monitor() {
         if (isFirstLaunch(context)) {
@@ -622,11 +626,25 @@ private boolean isOverCustomEventsRequirements() {
         }
     }
 
+    /**
+     * <p>Checks if the library is in Debug mode. <b>For development only!</b></p>
+     *
+     * @return true if the library is in Debug mode, false otherwise
+     */
     @SuppressWarnings({"unused", "WeakerAccess"})
     public boolean isDebug() {
         return isDebug;
     }
 
+    /**
+     * <p>Debug mode. <b>For development only!</b></p>
+     * <p>Setting the library to Debug mode ensures that the Rate Dialog will be shown each time
+     * the app is launched.</p>
+     *
+     * @param isDebug default is false, true ensures that the Rate Dialog will be shown each time
+     *                the app is launched
+     * @return AppRate singleton object
+     */
     public AppRate setDebug(@SuppressWarnings("SameParameterValue") boolean isDebug) {
         this.isDebug = isDebug;
         return this;

diff --git a/library/src/main/java/com/vorlonsoft/android/rate/OnClickButtonListener.java b/library/src/main/java/com/vorlonsoft/android/rate/OnClickButtonListener.java
@@ -8,8 +8,8 @@
 
 /**
  * <p>OnClickButtonListener Interface -  on click button listener interface
- * of the AndroidRate library. You can implements it and use
- * {@code AppRate.with(this).setOnClickButtonListener(OnClickButtonListener)]}
+ * of the AndroidRate library. You can implement it and use
+ * {@code AppRate.with(this).setOnClickButtonListener(OnClickButtonListener)}
  * to specify the callback when the button is pressed. The same value as the
  * second argument of {@link android.content.DialogInterface.OnClickListener#onClick}
  * will be passed in the argument of {@link OnClickButtonListener#onClickButton}.</p>