Change backticks to @code and @link in javadocs (firebase#140)

avishalom · web-flow · commit 50aa47ec9710 · 2018-02-13T00:21:03.000-05:00
* Change backticks to @code and @link in javadocs
diff --git a/src/main/java/com/google/firebase/auth/FirebaseAuth.java b/src/main/java/com/google/firebase/auth/FirebaseAuth.java
@@ -259,7 +259,7 @@ public Void call() throws Exception {
    * <p>While this will revoke all sessions for a specified user and disable any new ID tokens for
    * existing sessions from getting minted, existing ID tokens may remain active until their
    * natural expiration (one hour). 
-   * To verify that ID tokens are revoked, use `verifyIdToken(idToken, true)`.
+   * To verify that ID tokens are revoked, use {@link verifyIdTokenAsync(String, boolean)}.
    * 
    * @param uid The user id for which tokens are revoked.
    * @return An {@code ApiFuture} which will complete successfully or if updating the user fails,
@@ -286,7 +286,7 @@ public ApiFuture<Void> revokeRefreshTokensAsync(String uid) {
    * If the token is invalid, the future throws an exception indicating the failure.
    * 
    * <p>This does not check whether a token has been revoked. 
-   * See `verifyIdTokenAsync(token, checkRevoked)` below.
+   * See {@link verifyIdTokenAsync(String, boolean)} below.
    *
    * @param token A Firebase ID Token to verify and parse.
    * @return An {@code ApiFuture} which will complete successfully with the parsed token, or
@@ -308,7 +308,7 @@ public ApiFuture<FirebaseToken> verifyIdTokenAsync(final String token) {
    * associated with this FirebaseAuth instance (which by default is extracted from your service
    * account)
    * 
-   * <p>If `checkRevoked` is true, additionally checks if the token has been revoked.
+   * <p>If {@code checkRevoked} is true, additionally checks if the token has been revoked.
    * 
    * <p>If the token is valid, and not revoked, the returned Future will complete successfully and
    * provide a parsed version of the token from which the UID and other claims in the token can be
diff --git a/src/main/java/com/google/firebase/database/FirebaseDatabase.java b/src/main/java/com/google/firebase/database/FirebaseDatabase.java
@@ -280,10 +280,11 @@ public synchronized void setLogLevel(Logger.Level logLevel) {
    * connections and re-sends write operations when the network connection is restored.
    *
    * <p>However by default your write operations and cached data are only stored in-memory and will
-   * be lost when your app restarts. By setting this value to `true`, the data will be persisted to
-   * on-device (disk) storage and will thus be available again when the app is restarted (even when
-   * there is no network connectivity at that time). Note that this method must be called before
-   * creating your first Database reference and only needs to be called once per application.
+   * be lost when your app restarts. By setting this value to {@code true}, the data will be
+   * persisted to on-device (disk) storage and will thus be available again when the app is
+   * restarted (even when there is no network connectivity at that time). Note that this method
+   * must be called before creating your first Database reference and only needs to be called once
+   * per application.
    *
    * @param isEnabled Set to true to enable disk persistence, set to false to disable it.
    */
diff --git a/src/main/java/com/google/firebase/database/Query.java b/src/main/java/com/google/firebase/database/Query.java
@@ -237,13 +237,13 @@ public void run() {
   }
 
   /**
-   * By calling `keepSynced(true)` on a location, the data for that location will automatically be
-   * downloaded and kept in sync, even when no listeners are attached for that location.
-   * Additionally, while a location is kept synced, it will not be evicted from the persistent disk
-   * cache.
+   * By calling {@code keepSynced(true)} on a location, the data for that location will
+   * automatically be downloaded and kept in sync, even when no listeners are attached for that
+   * location. Additionally, while a location is kept synced, it will not be evicted from the
+   * persistent disk cache.
    *
-   * @param keepSynced Pass `true` to keep this location synchronized, pass `false` to stop
-   *     synchronization.
+   * @param keepSynced Pass {@code true} to keep this location synchronized, pass {@code false} to
+   *     stop synchronization.
    * @since 2.3
    */
   public void keepSynced(final boolean keepSynced) {
diff --git a/src/main/java/com/google/firebase/database/core/DatabaseConfig.java b/src/main/java/com/google/firebase/database/core/DatabaseConfig.java
@@ -133,7 +133,7 @@ public synchronized void setSessionPersistenceKey(String sessionKey) {
 
   /**
    * By default the Firebase Database client will keep data in memory while your application is
-   * running, but not when it is restarted. By setting this value to `true`, the data will be
+   * running, but not when it is restarted. By setting this value to {@code true} the data will be
    * persisted to on-device (disk) storage and will thus be available again when the app is
    * restarted (even when there is no network connectivity at that time). Note that this method must
    * be called before creating your first Database reference and only needs to be called once per

Original file line number	Diff line number	Diff line change
`@@ -259,7 +259,7 @@ public Void call() throws Exception {`
`259`	`259`	`* <p>While this will revoke all sessions for a specified user and disable any new ID tokens for`
`260`	`260`	`* existing sessions from getting minted, existing ID tokens may remain active until their`
`261`	`261`	`* natural expiration (one hour).`
`262`		- * To verify that ID tokens are revoked, use `verifyIdToken(idToken, true)`.
	`262`	`+ * To verify that ID tokens are revoked, use {@link verifyIdTokenAsync(String, boolean)}.`
`263`	`263`	`*`
`264`	`264`	`* @param uid The user id for which tokens are revoked.`
`265`	`265`	`* @return An {@code ApiFuture} which will complete successfully or if updating the user fails,`
`@@ -286,7 +286,7 @@ public ApiFuture<Void> revokeRefreshTokensAsync(String uid) {`
`286`	`286`	`* If the token is invalid, the future throws an exception indicating the failure.`
`287`	`287`	`*`
`288`	`288`	`* <p>This does not check whether a token has been revoked.`
`289`		- * See `verifyIdTokenAsync(token, checkRevoked)` below.
	`289`	`+ * See {@link verifyIdTokenAsync(String, boolean)} below.`
`290`	`290`	`*`
`291`	`291`	`* @param token A Firebase ID Token to verify and parse.`
`292`	`292`	`* @return An {@code ApiFuture} which will complete successfully with the parsed token, or`
`@@ -308,7 +308,7 @@ public ApiFuture<FirebaseToken> verifyIdTokenAsync(final String token) {`
`308`	`308`	`* associated with this FirebaseAuth instance (which by default is extracted from your service`
`309`	`309`	`* account)`
`310`	`310`	`*`
`311`		- * <p>If `checkRevoked` is true, additionally checks if the token has been revoked.
	`311`	`+ * <p>If {@code checkRevoked} is true, additionally checks if the token has been revoked.`
`312`	`312`	`*`
`313`	`313`	`* <p>If the token is valid, and not revoked, the returned Future will complete successfully and`
`314`	`314`	`* provide a parsed version of the token from which the UID and other claims in the token can be`