From 4abff13eb64752df17f11df3e17c1197da98f2da Mon Sep 17 00:00:00 2001 From: Hiranya Jayathilaka Date: Wed, 19 Apr 2017 13:18:08 -0700 Subject: [PATCH 1/2] Fixing some javadoc errors so DocLinters would shut up --- .../java/com/google/firebase/database/DatabaseError.java | 4 ---- .../java/com/google/firebase/database/DatabaseException.java | 2 -- .../java/com/google/firebase/database/InternalHelpers.java | 2 -- src/main/java/com/google/firebase/database/Query.java | 3 --- .../com/google/firebase/database/ValueEventListener.java | 5 +++-- .../com/google/firebase/database/core/DatabaseConfig.java | 1 - .../java/com/google/firebase/database/core/SyncPoint.java | 3 +-- .../java/com/google/firebase/database/logging/Logger.java | 2 +- .../java/com/google/firebase/internal/GetTokenResult.java | 1 - 9 files changed, 5 insertions(+), 18 deletions(-) diff --git a/src/main/java/com/google/firebase/database/DatabaseError.java b/src/main/java/com/google/firebase/database/DatabaseError.java index 726e24f4a..f4875b0cc 100644 --- a/src/main/java/com/google/firebase/database/DatabaseError.java +++ b/src/main/java/com/google/firebase/database/DatabaseError.java @@ -114,7 +114,6 @@ private DatabaseError(int code, String message, String details) { * * @param status The status string * @return An error corresponding the to the status - * @hide */ public static DatabaseError fromStatus(String status) { return fromStatus(status, null); @@ -126,7 +125,6 @@ public static DatabaseError fromStatus(String status) { * @param status The status string * @param reason The reason for the error * @return An error corresponding the to the status - * @hide */ public static DatabaseError fromStatus(String status, String reason) { return fromStatus(status, reason, null); @@ -139,7 +137,6 @@ public static DatabaseError fromStatus(String status, String reason) { * @param reason The reason for the error * @param details Additional details or null * @return An error corresponding the to the status - * @hide */ public static DatabaseError fromStatus(String status, String reason, String details) { Integer code = errorCodes.get(status.toLowerCase()); @@ -156,7 +153,6 @@ public static DatabaseError fromStatus(String status, String reason, String deta * * @param code The error code * @return An error corresponding the to the code - * @hide */ public static DatabaseError fromCode(int code) { if (!errorReasons.containsKey(code)) { diff --git a/src/main/java/com/google/firebase/database/DatabaseException.java b/src/main/java/com/google/firebase/database/DatabaseException.java index a437f68ea..259940b6f 100644 --- a/src/main/java/com/google/firebase/database/DatabaseException.java +++ b/src/main/java/com/google/firebase/database/DatabaseException.java @@ -10,7 +10,6 @@ public class DatabaseException extends RuntimeException { * For internal use * * @param message A human readable description of the error - * @hide */ public DatabaseException(String message) { super(message); @@ -21,7 +20,6 @@ public DatabaseException(String message) { * * @param message A human readable description of the error * @param cause The underlying cause for this error - * @hide */ public DatabaseException(String message, Throwable cause) { super(message, cause); diff --git a/src/main/java/com/google/firebase/database/InternalHelpers.java b/src/main/java/com/google/firebase/database/InternalHelpers.java index 69ee09c70..3b7913b68 100644 --- a/src/main/java/com/google/firebase/database/InternalHelpers.java +++ b/src/main/java/com/google/firebase/database/InternalHelpers.java @@ -10,8 +10,6 @@ /** * Internal helpers in com.google.firebase.database package (for use by core, tests, etc.) - * - * @hide */ public class InternalHelpers { diff --git a/src/main/java/com/google/firebase/database/Query.java b/src/main/java/com/google/firebase/database/Query.java index 683a9439f..881d9d6aa 100644 --- a/src/main/java/com/google/firebase/database/Query.java +++ b/src/main/java/com/google/firebase/database/Query.java @@ -622,7 +622,6 @@ public DatabaseReference getRef() { * For internal use * * @return The path to this location - * @hide */ public Path getPath() { return path; @@ -632,7 +631,6 @@ public Path getPath() { * For internal use * * @return The repo - * @hide */ public Repo getRepo() { return repo; @@ -642,7 +640,6 @@ public Repo getRepo() { * For internal use * * @return The constraints - * @hide */ public QuerySpec getSpec() { return new QuerySpec(path, params); diff --git a/src/main/java/com/google/firebase/database/ValueEventListener.java b/src/main/java/com/google/firebase/database/ValueEventListener.java index 151d42ba9..69051ece6 100644 --- a/src/main/java/com/google/firebase/database/ValueEventListener.java +++ b/src/main/java/com/google/firebase/database/ValueEventListener.java @@ -18,8 +18,9 @@ public interface ValueEventListener { /** * This method will be triggered in the event that this listener either failed at the server, or * is removed as a result of the security and Firebase Database rules. For more information on - * securing your data, see: Security Quickstart + * securing your data, see: + * + * Security Quickstart * * @param error A description of the error that occurred */ diff --git a/src/main/java/com/google/firebase/database/core/DatabaseConfig.java b/src/main/java/com/google/firebase/database/core/DatabaseConfig.java index 4f397054f..62ced8ce0 100644 --- a/src/main/java/com/google/firebase/database/core/DatabaseConfig.java +++ b/src/main/java/com/google/firebase/database/core/DatabaseConfig.java @@ -21,7 +21,6 @@ public class DatabaseConfig extends Context { * com.google.firebase.database.Logger Logger} interface. * * @param logger The custom logger that will be called with all log messages - * @hide */ public synchronized void setLogger(com.google.firebase.database.logging.Logger logger) { assertUnfrozen(); diff --git a/src/main/java/com/google/firebase/database/core/SyncPoint.java b/src/main/java/com/google/firebase/database/core/SyncPoint.java index 403f64c14..e66edc6a2 100644 --- a/src/main/java/com/google/firebase/database/core/SyncPoint.java +++ b/src/main/java/com/google/firebase/database/core/SyncPoint.java @@ -146,8 +146,7 @@ public List addEventRegistration( * @param query Query to remove the registration from. * @param eventRegistration If null, remove all callbacks. * @param cancelError If a cancelError is provided, appropriate cancel events will be returned. - * @return {{removed:!Array., events:!Array.}} removed queries - * and any cancel events + * @return a Pair of lists of consisting of removed queries and any cancel events. */ public Pair, List> removeEventRegistration( @NotNull QuerySpec query, diff --git a/src/main/java/com/google/firebase/database/logging/Logger.java b/src/main/java/com/google/firebase/database/logging/Logger.java index f92d407b5..f5e83d027 100644 --- a/src/main/java/com/google/firebase/database/logging/Logger.java +++ b/src/main/java/com/google/firebase/database/logging/Logger.java @@ -2,7 +2,7 @@ /** * Private (internal) logging interface used by Firebase Database. See {@link - * com.google.firebase.database.Config Config} for more information. + * com.google.firebase.database.core.DatabaseConfig DatabaseConfig} for more information. */ public interface Logger { diff --git a/src/main/java/com/google/firebase/internal/GetTokenResult.java b/src/main/java/com/google/firebase/internal/GetTokenResult.java index a2ae97f4e..d33f52b82 100644 --- a/src/main/java/com/google/firebase/internal/GetTokenResult.java +++ b/src/main/java/com/google/firebase/internal/GetTokenResult.java @@ -9,7 +9,6 @@ public class GetTokenResult { /** * @param token represents the {@link String} access token. - * @hide */ public GetTokenResult(String token) { this.token = token; From 4b107ad11128820d6e6f4dd147c6e094abf7489b Mon Sep 17 00:00:00 2001 From: Hiranya Jayathilaka Date: Wed, 19 Apr 2017 13:47:29 -0700 Subject: [PATCH 2/2] Fixed typo --- src/main/java/com/google/firebase/database/core/SyncPoint.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/main/java/com/google/firebase/database/core/SyncPoint.java b/src/main/java/com/google/firebase/database/core/SyncPoint.java index e66edc6a2..57e8ff8f0 100644 --- a/src/main/java/com/google/firebase/database/core/SyncPoint.java +++ b/src/main/java/com/google/firebase/database/core/SyncPoint.java @@ -146,7 +146,7 @@ public List addEventRegistration( * @param query Query to remove the registration from. * @param eventRegistration If null, remove all callbacks. * @param cancelError If a cancelError is provided, appropriate cancel events will be returned. - * @return a Pair of lists of consisting of removed queries and any cancel events. + * @return a Pair of lists consisting of removed queries and any cancel events. */ public Pair, List> removeEventRegistration( @NotNull QuerySpec query,