Skip to content

Fixing some javadoc errors so Doc Linters would shut up #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hiranya911 merged 2 commits into from
Apr 19, 2017
Merged

Fixing some javadoc errors so Doc Linters would shut up #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4abff13
Fixing some javadoc errors so DocLinters would shut up
Apr 19, 2017
4b107ad
Fixed typo
Apr 19, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions src/main/java/com/google/firebase/database/DatabaseError.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand All @@ -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);
Expand All @@ -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());
Expand All @@ -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)) {
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/com/google/firebase/database/DatabaseException.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ public class DatabaseException extends RuntimeException {
* <strong>For internal use</strong>
*
* @param message A human readable description of the error
* @hide
*/
public DatabaseException(String message) {
super(message);
Expand All @@ -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);
Expand Down
2 changes: 0 additions & 2 deletions src/main/java/com/google/firebase/database/InternalHelpers.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,6 @@

/**
* Internal helpers in com.google.firebase.database package (for use by core, tests, etc.)
*
* @hide
*/
public class InternalHelpers {

Expand Down
3 changes: 0 additions & 3 deletions src/main/java/com/google/firebase/database/Query.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -622,7 +622,6 @@ public DatabaseReference getRef() {
* <strong>For internal use</strong>
*
* @return The path to this location
* @hide
*/
public Path getPath() {
return path;
Expand All @@ -632,7 +631,6 @@ public Path getPath() {
* <strong>For internal use</strong>
*
* @return The repo
* @hide
*/
public Repo getRepo() {
return repo;
Expand All @@ -642,7 +640,6 @@ public Repo getRepo() {
* <strong>For internal use</strong>
*
* @return The constraints
* @hide
*/
public QuerySpec getSpec() {
return new QuerySpec(path, params);
Expand Down
5 changes: 3 additions & 2 deletions src/main/java/com/google/firebase/database/ValueEventListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <a href="https://firebase.google
* .com/docs/database/security/quickstart" target="_blank"> Security Quickstart</a>
* securing your data, see:
* <a href="https://firebase.google.com/docs/database/security/quickstart" target="_blank">
* Security Quickstart</a>
*
* @param error A description of the error that occurred
*/
Expand Down
1 change: 0 additions & 1 deletion src/main/java/com/google/firebase/database/core/DatabaseConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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();
Expand Down
3 changes: 1 addition & 2 deletions src/main/java/com/google/firebase/database/core/SyncPoint.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,8 +146,7 @@ public List<DataEvent> 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.<!fb.api.Query>, events:!Array.<!fb.core.view.Event>}} removed queries
* and any cancel events
* @return a Pair of lists consisting of removed queries and any cancel events.

@mikelehen mikelehen Apr 19, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just FYI- We should not be including anything under core/ (or any other subpackage) when generating javadoc. :)

*/
public Pair<List<QuerySpec>, List<Event>> removeEventRegistration(
@NotNull QuerySpec query,
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/com/google/firebase/database/logging/Logger.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 {

Expand Down
1 change: 0 additions & 1 deletion src/main/java/com/google/firebase/internal/GetTokenResult.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,6 @@ public class GetTokenResult {

/**
* @param token represents the {@link String} access token.
* @hide
*/
public GetTokenResult(String token) {
this.token = token;
Expand Down