From 545821bcdeb43731b1b9d831d3a1bf451c814a4b Mon Sep 17 00:00:00 2001 From: hiranya911 Date: Fri, 4 May 2018 11:26:25 -0700 Subject: [PATCH] Minor API doc fixes --- src/main/java/com/google/firebase/ThreadManager.java | 2 +- src/main/java/com/google/firebase/auth/FirebaseAuth.java | 4 ++-- .../com/google/firebase/database/ChildEventListener.java | 2 +- .../java/com/google/firebase/database/DataSnapshot.java | 8 ++++---- .../java/com/google/firebase/database/MutableData.java | 4 ++-- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/main/java/com/google/firebase/ThreadManager.java b/src/main/java/com/google/firebase/ThreadManager.java index 4f3c5f29d..8903101f6 100644 --- a/src/main/java/com/google/firebase/ThreadManager.java +++ b/src/main/java/com/google/firebase/ThreadManager.java @@ -57,7 +57,7 @@ final void releaseFirebaseExecutors( * {@link #getThreadFactory()} method. * * @param app A {@link FirebaseApp} instance. - * @return A non-null {@link ExecutorService} instance. + * @return A non-null ExecutorService instance. */ @NonNull protected abstract ExecutorService getExecutor(@NonNull FirebaseApp app); diff --git a/src/main/java/com/google/firebase/auth/FirebaseAuth.java b/src/main/java/com/google/firebase/auth/FirebaseAuth.java index 7517b0e7e..3181dc5b1 100644 --- a/src/main/java/com/google/firebase/auth/FirebaseAuth.java +++ b/src/main/java/com/google/firebase/auth/FirebaseAuth.java @@ -163,7 +163,7 @@ protected String execute() throws FirebaseAuthException { * Parses and verifies a Firebase session cookie. * *

If verified successfully, returns a parsed version of the cookie from which the UID and the - * other claims can be read. If the cookie is invalid, throws a {@link FirebaseAuthException\}. + * other claims can be read. If the cookie is invalid, throws a {@link FirebaseAuthException}. * *

This method does not check whether the cookie has been revoked. See * {@link #verifySessionCookie(String, boolean)}. @@ -318,7 +318,7 @@ public ApiFuture createCustomTokenAsync(@NonNull String uid) { } /** - * Similar to {@link #createCustomToken(String, Map)} )} but performs the operation + * Similar to {@link #createCustomToken(String, Map)} but performs the operation * asynchronously. * * @param uid The UID to store in the token. This identifies the user to other Firebase services diff --git a/src/main/java/com/google/firebase/database/ChildEventListener.java b/src/main/java/com/google/firebase/database/ChildEventListener.java index 1a1bb24d1..65bcdfdce 100644 --- a/src/main/java/com/google/firebase/database/ChildEventListener.java +++ b/src/main/java/com/google/firebase/database/ChildEventListener.java @@ -53,7 +53,7 @@ public interface ChildEventListener { /** * This method is triggered when a child location's priority changes. See {@link - * DatabaseReference#setPriority(Object)} and Ordered Data for more information on priorities and ordering data. * diff --git a/src/main/java/com/google/firebase/database/DataSnapshot.java b/src/main/java/com/google/firebase/database/DataSnapshot.java index 700fa2a2a..f1f470505 100644 --- a/src/main/java/com/google/firebase/database/DataSnapshot.java +++ b/src/main/java/com/google/firebase/database/DataSnapshot.java @@ -38,7 +38,7 @@ * They are efficiently-generated immutable copies of the data at a Firebase Database location. They * can't be modified and will never change. To modify data at a location, use a {@link * DatabaseReference DatabaseReference} reference (e.g. with {@link - * DatabaseReference#setValue(Object)}). + * DatabaseReference#setValueAsync(Object)}). */ public class DataSnapshot { @@ -114,7 +114,7 @@ public boolean exists() { *

  • List<Object> * * - *

    This list is recursive; the possible types for {@link java.lang.Object} in the above list + *

    This list is recursive; the possible types for Object in the above list * is given by the same list. These types correspond to the types available in JSON. * * @return The data contained in this snapshot as native types or null if there is no data at this @@ -138,7 +138,7 @@ public Object getValue() { *

  • List<Object> * * - *

    This list is recursive; the possible types for {@link java.lang.Object} in the above list is + *

    This list is recursive; the possible types for Object in the above list is * given by the same list. These types correspond to the types available in JSON. * *

    If useExportFormat is set to true, priority information will be included in the output. @@ -206,7 +206,7 @@ public T getValue(Class valueType) { /** * Due to the way that Java implements generics, it takes an extra step to get back a - * properly-typed Collection. So, in the case where you want a {@link java.util.List} of Message + * properly-typed Collection. So, in the case where you want a List of Message * instances, you will need to do something like the following: * *

    
    diff --git a/src/main/java/com/google/firebase/database/MutableData.java b/src/main/java/com/google/firebase/database/MutableData.java
    index 79e87f2b4..7a0e7983b 100644
    --- a/src/main/java/com/google/firebase/database/MutableData.java
    +++ b/src/main/java/com/google/firebase/database/MutableData.java
    @@ -177,7 +177,7 @@ public String getKey() {
        *   
  • List<Object> * * - *

    This list is recursive; the possible types for {@link java.lang.Object} in the above list is + *

    This list is recursive; the possible types for Object in the above list is * given by the same list. These types correspond to the types available in JSON. * * @return The data contained in this instance as native types, or null if there is no data at @@ -190,7 +190,7 @@ public Object getValue() { /** * Due to the way that Java implements generics, it takes an extra step to get back a - * properly-typed Collection. So, in the case where you want a {@link java.util.List} of Message + * properly-typed Collection. So, in the case where you want a List of Message * instances, you will need to do something like the following: * *