Bug 1641475 - [1.0] Fix Javadoc warnings. r=geckoview-reviewers,droeh

Differential Revision: https://phabricator.services.mozilla.com/D77311

mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlocking.java

@@ -214,7 +214,7 @@ public class ContentBlocking {
          * Set whether or not strict social tracking protection is enabled
          * (ie, whether to block content or just cookies). Will only block
          * if social tracking protection lists are supplied to
-         * {@link setAntiTracking}.
+         * {@link #setAntiTracking}.
          *
          * @param enabled A boolean indicating whether or not to enable strict
          *                social tracking protection.
@@ -350,7 +350,7 @@ public class ContentBlocking {
 
         /**
          * Block social trackers. Note: This is not the same as "Social Tracking Protection",
-         * which is controlled by {@link STP}.
+         * which is controlled by {@link #STP}.
          */
         public static final int SOCIAL = 1 << 3;
 

mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlockingController.java

@@ -67,7 +67,7 @@ public class ContentBlockingController {
          * Returns a ContentBlockingException reconstructed from JSON.
          *
          * @param savedException A JSONObject representation of a saved exception; should be the output of
-         *                       {@link toJson}.
+         *                       {@link #toJson}.
          *
          * @return A ContentBlockingException reconstructed from the supplied JSONObject.
          *
@@ -133,7 +133,7 @@ public class ContentBlockingController {
 
         /**
          * Creates a new exception list from a string. The string should be valid
-         * output from {@link toString}.
+         * output from {@link #toString}.
          *
          * @param savedList A string representation of a saved exception list.
          *
@@ -145,7 +145,7 @@ public class ContentBlockingController {
 
         /**
          * Creates a new exception list from a JSONObject. The JSONObject should be valid
-         * output from {@link toJson}.
+         * output from {@link #toJson}.
          *
          * @param savedList A JSONObject representation of a saved exception list.
          *
@@ -263,7 +263,7 @@ public class ContentBlockingController {
     /**
      * Restore the supplied {@link ExceptionList}, overwriting the existing exception list.
      *
-     * @param list An {@link ExceptionList} originally created by {@link saveExceptionList}.
+     * @param list An {@link ExceptionList} originally created by {@link #saveExceptionList}.
      */
     @Deprecated
     @UiThread
@@ -274,7 +274,7 @@ public class ContentBlockingController {
     /**
      * Restore the supplied List of {@link ContentBlockingException}, overwriting the existing exception list.
      *
-     * @param list A List of {@link ContentBlockingException} originally created by {@link saveExceptionList}.
+     * @param list A List of {@link ContentBlockingException} originally created by {@link #saveExceptionList}.
      */
     @AnyThread
     public void restoreExceptionList(final @NonNull List<ContentBlockingException> list) {
@@ -354,14 +354,14 @@ public class ContentBlockingController {
         public static final int COOKIES_LOADED                  = 0x00008000;
 
         /**
-         * Similar to {@link COOKIES_LOADED}, but only sent if the subject of the
+         * Similar to {@link #COOKIES_LOADED}, but only sent if the subject of the
          * action was a third-party tracker when the active cookie policy imposes
          * restrictions on such content.
          */
         public static final int COOKIES_LOADED_TRACKER          = 0x00040000;
 
         /**
-         * Similar to {@link COOKIES_LOADED}, but only sent if the subject of the
+         * Similar to {@link #COOKIES_LOADED}, but only sent if the subject of the
          * action was a third-party social tracker when the active cookie policy
          * imposes restrictions on such content.
          */

mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoRuntimeSettings.java

@@ -283,7 +283,7 @@ public final class GeckoRuntimeSettings extends RuntimeSettings {
         /**
          * Set whether login forms should be filled automatically if only one
          * viable candidate is provided via
-         * {@link Autocomplete.LoginStorageDelegate.onLoginFetch onLoginFetch}.
+         * {@link Autocomplete.LoginStorageDelegate#onLoginFetch onLoginFetch}.
          *
          * @param enabled A flag determining whether login autofill should be
          *                enabled.
@@ -1115,7 +1115,7 @@ public final class GeckoRuntimeSettings extends RuntimeSettings {
     /**
      * Set whether login forms should be filled automatically if only one
      * viable candidate is provided via
-     * {@link Autocomplete.LoginStorageDelegate.onLoginFetch onLoginFetch}.
+     * {@link Autocomplete.LoginStorageDelegate#onLoginFetch onLoginFetch}.
      *
      * @param enabled A flag determining whether login autofill should be
      *                enabled.

mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoSession.java

@@ -3386,7 +3386,7 @@ public class GeckoSession implements Parcelable {
 
             /**
              * Checks if the passed action is available
-             * @param action An {@link SelectionActionDelegateAction} to perform
+             * @param action An {@link SelectionActionDelegate} to perform
              * @return True if the action is available.
              */
             @AnyThread
@@ -3395,10 +3395,10 @@ public class GeckoSession implements Parcelable {
             }
 
             /**
-             * Execute an {@link SelectionActionDelegateAction} action.
+             * Execute an {@link SelectionActionDelegate} action.
              *
              * @throws IllegalStateException If the action was not available.
-             * @param action A {@link SelectionActionDelegateAction} action.
+             * @param action A {@link SelectionActionDelegate} action.
              */
             @AnyThread
             public void execute(@NonNull @SelectionActionDelegateAction final String action) {
@@ -4797,6 +4797,12 @@ public class GeckoSession implements Parcelable {
             /**
              * Confirm the request by responding with a selection.
              * See the PromptDelegate callbacks for specifics.
+             *
+             * @param selection The {@link Autocomplete.Option} used to confirm
+             *                  the request.
+             *
+             * @return A {@link PromptResponse} which can be used to complete
+             *         the {@link GeckoResult} associated with this prompt.
              */
             @UiThread
             public @NonNull PromptResponse confirm(
@@ -4808,6 +4814,9 @@ public class GeckoSession implements Parcelable {
             /**
              * Dismiss the request.
              * See the PromptDelegate callbacks for specifics.
+             *
+             * @return A {@link PromptResponse} which can be used to complete
+             *         the {@link GeckoResult} associated with this prompt.
              */
             @UiThread
             public @NonNull PromptResponse dismiss() {