Bug 1641475 - [1.0] Fix Javadoc warnings. r=geckoview-reviewers,droeh
authorEugen Sawin <esawin@mozilla.com>
Thu, 28 May 2020 21:12:05 +0000
changeset 596594 4a1540970cae5d08ee4e93711a84deeff32c4a25
parent 596593 68cf56d38bb44a2bf741e5169a00776ba359b24a
child 596595 5134aaa3278ebfb0e20bf35cc9f5b3aedec628f8
push id13186
push userffxbld-merge
push dateMon, 01 Jun 2020 09:52:46 +0000
treeherdermozilla-beta@3e7c70a1e4a1 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersgeckoview-reviewers, droeh
bugs1641475
milestone78.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
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
mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlockingController.java
mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoRuntimeSettings.java
mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoSession.java
--- a/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlocking.java
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlocking.java
@@ -209,17 +209,17 @@ public class ContentBlocking {
             mEtpStrict.commit(level == ContentBlocking.EtpLevel.STRICT);
             return this;
         }
 
         /**
          * 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.
          * @return This Settings instance.
          */
         public @NonNull Settings setStrictSocialTrackingProtection(final boolean enabled) {
             mStStrict.commit(enabled);
             return this;
@@ -345,17 +345,17 @@ public class ContentBlocking {
 
         /**
          * Block analytics trackers.
          */
         public static final int ANALYTIC = 1 << 2;
 
         /**
          * 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;
 
         /**
          * Block content trackers.
          * May cause issues with some web sites.
          */
         public static final int CONTENT = 1 << 4;
--- a/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlockingController.java
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/ContentBlockingController.java
@@ -62,17 +62,17 @@ public class ContentBlockingController {
             return res;
         }
 
         /**
          *
          * 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.
          *
          * @throws JSONException if the JSONObject cannot be converted for any reason.
          */
         public static @NonNull ContentBlockingException fromJson(final @NonNull JSONObject savedException) throws JSONException {
             return new ContentBlockingException(savedException.getString("principal"), savedException.getString("uri"));
         }
@@ -128,29 +128,29 @@ public class ContentBlockingController {
          * @throws JSONException if conversion to JSONObject fails.
          */
         public @NonNull JSONObject toJson() throws JSONException {
             return mBundle.toJSONObject();
         }
 
         /**
          * 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.
          *
          * @throws JSONException if the string representation no longer represents valid JSON.
          */
         public ExceptionList(final @NonNull String savedList) throws JSONException {
             mBundle = GeckoBundle.fromJSONObject(new JSONObject(savedList));
         }
 
         /**
          * 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.
          *
          * @throws JSONException if the JSONObject cannot be converted for any reason.
          */
         public ExceptionList(final @NonNull JSONObject savedList) throws JSONException {
             mBundle = GeckoBundle.fromJSONObject(savedList);
         }
@@ -258,28 +258,28 @@ public class ContentBlockingController {
         };
         EventDispatcher.getInstance().dispatch("ContentBlocking:SaveList", null, result);
         return result;
     }
 
     /**
      * 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
     public void restoreExceptionList(final @NonNull ExceptionList list) {
         EventDispatcher.getInstance().dispatch("ContentBlocking:RestoreList", list.getBundle());
     }
 
     /**
      * 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) {
         final GeckoBundle bundle = new GeckoBundle(2);
         final String[] principals = new String[list.size()];
         final String[] uris = new String[list.size()];
 
         for (int i = 0; i < list.size(); i++) {
@@ -349,24 +349,24 @@ public class ContentBlockingController {
          * cookie or a storage item was loaded/stored on the current tab.
          * Alternatively this could indicate that something in the current tab
          * attempted to communicate with its same-origin counterparts in other
          * tabs.
          */
         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.
          */
         public static final int COOKIES_LOADED_SOCIALTRACKER    = 0x00080000;
 
         /**
          * Rejected for custom site permission.
          */
--- a/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoRuntimeSettings.java
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoRuntimeSettings.java
@@ -278,17 +278,17 @@ public final class GeckoRuntimeSettings 
             getSettings().mScreenWidthOverride = width;
             getSettings().mScreenHeightOverride = height;
             return this;
         }
 
         /**
          * 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.
          * @return The builder instance.
          */
         public @NonNull Builder loginAutofillEnabled(final boolean enabled) {
             getSettings().setLoginAutofillEnabled(enabled);
             return this;
@@ -1110,17 +1110,17 @@ public final class GeckoRuntimeSettings 
      */
     public boolean getLoginAutofillEnabled() {
         return mAutofillLogins.get();
     }
 
     /**
      * 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.
      * @return The builder instance.
      */
     public @NonNull GeckoRuntimeSettings setLoginAutofillEnabled(
             final boolean enabled) {
         mAutofillLogins.commit(enabled);
--- a/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoSession.java
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/GeckoSession.java
@@ -3381,29 +3381,29 @@ public class GeckoSession implements Par
                 clientRect = null;
                 availableActions = new HashSet<>();
                 mSeqNo = 0;
                 mEventCallback = null;
             }
 
             /**
              * 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
             public boolean isActionAvailable(@NonNull @SelectionActionDelegateAction final String action) {
                 return availableActions.contains(action);
             }
 
             /**
-             * 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) {
                 if (!isActionAvailable(action)) {
                     throw new IllegalStateException("Action not available");
                 }
                 final GeckoBundle response = new GeckoBundle(2);
                 response.putString("id", action);
@@ -4792,27 +4792,36 @@ public class GeckoSession implements Par
             protected AutocompleteRequest(final @NonNull T[] options) {
                 super(null);
                 this.options = options;
             }
 
             /**
              * 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(
                     final @NonNull Autocomplete.Option<?> selection) {
                 ensureResult().putBundle("selection", selection.toBundle());
                 return super.confirm();
             }
 
             /**
              * 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() {
                 return super.dismiss();
             }
         }
 
         // Delegate functions.