Skip to content

Commit 5358f16

Browse files
authored
Updated Firestore and GCS docs (#93)
1 parent 202c332 commit 5358f16

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

src/main/java/com/google/firebase/cloud/FirestoreClient.java

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,9 @@
1212
import com.google.firebase.internal.NonNull;
1313

1414
/**
15-
* FirestoreClient provides access to Google Cloud Firestore. Use this API to obtain a
16-
* <code>com.google.cloud.firestore.Firestore</code> instance, which provides methods for
17-
* updating and querying data in Firestore.
15+
* {@code FirestoreClient} provides access to Google Cloud Firestore. Use this API to obtain a
16+
* <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/firestore/Firestore.html">{@code Firestore}</a>
17+
* instance, which provides methods for updating and querying data in Firestore.
1818
*
1919
* <p>A Google Cloud project ID is required to access Firestore. FirestoreClient determines the
2020
* project ID from the {@link com.google.firebase.FirebaseOptions} used to initialize the underlying
@@ -44,7 +44,8 @@ private FirestoreClient(FirebaseApp app) {
4444
/**
4545
* Returns the Firestore instance associated with the default Firebase app.
4646
*
47-
* @return A non-null <code>com.google.cloud.firestore.Firestore</code> instance.
47+
* @return A non-null <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/firestore/Firestore.html">{@code Firestore}</a>
48+
* instance.
4849
*/
4950
@NonNull
5051
public static Firestore getFirestore() {
@@ -55,7 +56,8 @@ public static Firestore getFirestore() {
5556
* Returns the Firestore instance associated with the specified Firebase app.
5657
*
5758
* @param app A non-null {@link FirebaseApp}.
58-
* @return A non-null <code>com.google.cloud.firestore.Firestore</code> instance.
59+
* @return A non-null <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/firestore/Firestore.html">{@code Firestore}</a>
60+
* instance.
5961
*/
6062
@NonNull
6163
public static Firestore getFirestore(FirebaseApp app) {

src/main/java/com/google/firebase/cloud/StorageClient.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,8 @@ public static synchronized StorageClient getInstance(FirebaseApp app) {
6767
* configured via {@link com.google.firebase.FirebaseOptions} when initializing the app. If
6868
* no bucket was configured via options, this method throws an exception.
6969
*
70-
* @return a cloud storage Bucket instance, or null if the configured bucket does not exist.
70+
* @return a cloud storage <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/storage/Bucket.html">{@code Bucket}</a>
71+
* instance.
7172
* @throws IllegalArgumentException If no bucket is configured via <code>FirebaseOptions</code>,
7273
* or if the bucket does not exist.
7374
*/
@@ -79,7 +80,8 @@ public Bucket bucket() {
7980
* Returns a cloud storage Bucket instance for the specified bucket name.
8081
*
8182
* @param name a non-null, non-empty bucket name.
82-
* @return a cloud storage Bucket instance, or null if the specified bucket does not exist.
83+
* @return a cloud storage <a href="https://googlecloudplatform.github.io/google-cloud-java/latest/apidocs/com/google/cloud/storage/Bucket.html">{@code Bucket}</a>
84+
* instance.
8385
* @throws IllegalArgumentException If the bucket name is null, empty, or if the specified
8486
* bucket does not exist.
8587
*/

0 commit comments

Comments
 (0)