Skip to content

Commit 5090d39

Browse files
authored
Updated API docs (firebase#82)
* Updated API docs * Minor changes to apidoc text
1 parent 122595a commit 5090d39

File tree

5 files changed

+20
-9
lines changed

5 files changed

+20
-9
lines changed

src/main/java/com/google/firebase/FirebaseOptions.java

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,17 @@ public Builder setStorageBucket(String storageBucket) {
193193
return this;
194194
}
195195

196+
/**
197+
* Sets the <code>GoogleCredentials</code> to use to authenticate the SDK.
198+
*
199+
* <p>See <a href="https://firebase.google.com/docs/admin/setup#initialize_the_sdk">
200+
* Initialize the SDK</a> for code samples and detailed documentation.
201+
*
202+
* @param credentials A
203+
* <a href="http://google.github.io/google-auth-library-java/releases/0.7.1/apidocs/com/google/auth/oauth2/GoogleCredentials.html">{@code GoogleCredentials}</a>
204+
* instance used to authenticate the SDK.
205+
* @return This <code>Builder</code> instance is returned so subsequent calls can be chained.
206+
*/
196207
public Builder setCredentials(GoogleCredentials credentials) {
197208
this.credentials = checkNotNull(credentials);
198209
return this;
@@ -201,9 +212,6 @@ public Builder setCredentials(GoogleCredentials credentials) {
201212
/**
202213
* Sets the <code>FirebaseCredential</code> to use to authenticate the SDK.
203214
*
204-
* <p>See <a href="https://firebase.google.com/docs/admin/setup#initialize_the_sdk">
205-
* Initialize the SDK</a> for code samples and detailed documentation.
206-
*
207215
* @param credential A <code>FirebaseCredential</code> used to authenticate the SDK. See {@link
208216
* FirebaseCredentials} for default implementations.
209217
* @return This <code>Builder</code> instance is returned so subsequent calls can be chained.

src/main/java/com/google/firebase/ThreadManager.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,9 @@
2828
/**
2929
* An interface that controls the thread pools and thread factories used by the Admin SDK. Each
3030
* instance of {@link FirebaseApp} uses an implementation of this interface to create and manage
31-
* threads. Multiple app instances may use the same <code>ThreadManager</code> instance.
31+
* threads.
32+
*
33+
* <p>Multiple app instances may use the same <code>ThreadManager</code> instance.
3234
* Methods in this interface may get invoked multiple times by the same
3335
* app, during its lifetime. Apps may also invoke methods of this interface concurrently, and
3436
* therefore implementations should provide any synchronization necessary.

src/main/java/com/google/firebase/auth/FirebaseCredential.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
* you will not need to implement this yourself and can instead use the default implementations
2424
* provided by {@link FirebaseCredentials}.
2525
*
26-
* @deprecated Use GoogleCredentials
26+
* @deprecated Use <a href="http://google.github.io/google-auth-library-java/releases/0.7.1/apidocs/com/google/auth/oauth2/GoogleCredentials.html">{@code GoogleCredentials}</a>.
2727
*/
2828
public interface FirebaseCredential {
2929

src/main/java/com/google/firebase/auth/FirebaseCredentials.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
* Standard {@link FirebaseCredential} implementations for use with {@link
3838
* com.google.firebase.FirebaseOptions}.
3939
*
40-
* @deprecated Use GoogleCredentials.
40+
* @deprecated Use <a href="http://google.github.io/google-auth-library-java/releases/0.7.1/apidocs/com/google/auth/oauth2/GoogleCredentials.html">{@code GoogleCredentials}</a>.
4141
*/
4242
public class FirebaseCredentials {
4343

src/main/java/com/google/firebase/tasks/Task.java

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,10 @@
2525
* Represents an asynchronous operation.
2626
*
2727
* @param <T> the type of the result of the operation
28-
* @deprecated Task has been deprecated in favor of ApiFuture. For every method xyz() that returns
29-
* a {@code Task<T>}, you should be able to find a corresponding xyzAsync() method that returns
30-
* an {@code ApiFuture<T>}.
28+
* @deprecated {@code Task} has been deprecated in favor of
29+
* <a href="https://googleapis.github.io/api-common-java/1.1.0/apidocs/com/google/api/core/ApiFuture.html">{@code ApiFuture}</a>.
30+
* For every method x() that returns a {@code Task<T>}, you should be able to find a
31+
* corresponding xAsync() method that returns an {@code ApiFuture<T>}.
3132
*/
3233
public abstract class Task<T> {
3334

0 commit comments

Comments
 (0)