Bug 1610353 - [4.0] Try to make top-level docs prettier. r=agi
authorEugen Sawin <esawin@mozilla.com>
Thu, 23 Jan 2020 20:04:00 +0000
changeset 511531 d0a06daef257a64e1c761035784e623106d5cbb4
parent 511530 282778a58d0b3b676d77a56235259514e074d959
child 511532 6a2d19e7cdf24bbe2ee1ff05f00730281b0189a6
push id37049
push userrmaries@mozilla.com
push dateFri, 24 Jan 2020 03:50:24 +0000
treeherdermozilla-central@e05793f68994 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersagi
bugs1610353
milestone74.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 1610353 - [4.0] Try to make top-level docs prettier. r=agi Differential Revision: https://phabricator.services.mozilla.com/D60443
mobile/android/geckoview/src/main/java/org/mozilla/geckoview/LoginStorage.java
--- a/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/LoginStorage.java
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/LoginStorage.java
@@ -21,79 +21,94 @@ import org.mozilla.gecko.util.BundleEven
 import org.mozilla.gecko.util.EventCallback;
 import org.mozilla.gecko.util.GeckoBundle;
 
 /**
  * The Login Storage API provides a storage-level delegate to leverage Gecko's
  * complete range of heuristics for login forms, autofill and autocomplete
  * scenarios.
  *
- * Examples
+ * <h2>Examples</h2>
  *
- * Autofill/Fetch API
- *
+ * <h3>Autofill/Fetch API</h3>
+ * <p>
  * GeckoView loads <code>https://example.com</code> which contains (for the
  * purpose of this example) elements resembling a login form, e.g.,
  * <pre><code>
  *   &lt;form&gt;
  *     &lt;input type=&quot;text&quot; placeholder=&quot;username&quot;&gt;
  *     &lt;input type=&quot;password&quot; placeholder=&quot;password&quot;&gt;
  *     &lt;input type=&quot;submit&quot; value=&quot;submit&quot;&gt;
  *   &lt;/form&gt;
  * </code></pre>
- *
+ * </p>
+ * <p>
  * With the document parsed and the login input fields identified, GeckoView
  * dispatches a
  * <code>LoginStorage.Delegate.onLoginFetch(&quot;example.com&quot;)</code>
  * request to fetch logins for the given domain.
+ * </p>
  *
+ * <p>
  * Based on the provided login entries, GeckoView will attempt to autofill the
  * login input fields.
+ * </p>
  *
- * Update API
- *
+ * <h3>Update API</h3>
+ * <p>
  * When the user submits some login input fields, GeckoView dispatches another
  * <code>LoginStorage.Delegate.onLoginFetch(&quot;example.com&quot;)</code>
  * request to check whether the submitted login exists or whether it's a new or
  * updated login entry.
+ * </p>
+ * <p>
  * If the submitted login is already contained as-is in the collection returned
  * by <code>onLoginFetch</code>, then GeckoView dispatches
  * <code>LoginStorage.Delegate.onLoginUsed</code> with the submitted login
  * entry.
+ * </p>
+ * <p>
  * If the submitted login is a new or updated entry, GeckoView dispatches
  * a sequence of requests to save/update the login entry, see the Save API
  * example.
+ * </p>
  *
- * Save API
+ * <h3>Save API</h3>
  *
+ * <p>
  * The user enters new or updated (password) login credentials in some login
  * input fields and submits explicitely (submit action) or by navigation.
  * GeckoView identifies the entered credentials and dispatches a
  * <code>GeckoSession.PromptDelegate.onLoginStoragePrompt(session, prompt)</code>
  * request with the <code>prompt</code> being of type
  * <code>LoginStoragePrompt.Type.SAVE</code> and containing the entered
  * credentials.
+ * </p>
  *
+ * <p>
  * The app may dismiss the prompt request via
  * <code>return GeckoResult.fromValue(prompt.dismiss())</code>
  * which terminates this saving request, or confirm it via
  * <code>return GeckoResult.fromValue(prompt.confirm(login))</code>
  * where <code>login</code> either holds the credentials originally provided by
  * the prompt request (<code>prompt.logins[0]</code>) or a new or modified login
  * entry.
+ * </p>
  *
+ * <p>
  * The login entry returned in a confirmed save prompt is used to request for
  * saving in the runtime delegate via
  * <code>LoginStorage.Delegate.onLoginSave(login)</code>.
  * If the app has already stored the entry during the prompt request handling,
  * it may ignore this storage saving request.
+ * </p>
  *
- * @see GeckoRuntime#setLoginStorageDelegate
- * @see GeckoSession#setPromptDelegate
- * @see GeckoSession.PromptDelegate#onLoginStoragePrompt
+ * <br>@see GeckoRuntime#setLoginStorageDelegate
+ * <br>@see GeckoSession#setPromptDelegate
+ * <br>@see GeckoSession.PromptDelegate#onLoginStoragePrompt
  */
 public class LoginStorage {
     private static final String LOGTAG = "LoginStorage";
     private static final boolean DEBUG = false;
 
     /**
      * Holds login information for a specific entry.
      */