From 96d9e06ffc3e56e542e3ae368267c7b4c0490a17 Mon Sep 17 00:00:00 2001 From: AYM1607 Date: Fri, 5 Apr 2019 14:34:28 -0600 Subject: [PATCH] Added docs for the providers --- lib/src/resources/firebase_storage_provider.dart | 5 +++++ lib/src/resources/firestore_provider.dart | 2 +- lib/src/resources/google_sign_in_provider.dart | 2 +- 3 files changed, 7 insertions(+), 2 deletions(-) diff --git a/lib/src/resources/firebase_storage_provider.dart b/lib/src/resources/firebase_storage_provider.dart index a0db736..317307d 100644 --- a/lib/src/resources/firebase_storage_provider.dart +++ b/lib/src/resources/firebase_storage_provider.dart @@ -6,9 +6,14 @@ import 'package:uuid/uuid.dart'; export 'package:firebase_storage/firebase_storage.dart' show StorageUploadTask, StorageTaskSnapshot; +/// A connection to the firebase sotrage bucket. class FirebaseStorageProvider { + /// The reference to the root path of the storage bucket. final StorageReference _storage; + + /// An instance of a uuid generator. final Uuid _uuid; + // [FirebaseStorage] and [Uuid] instances can be injected for testing purposes. // Don't remove. FirebaseStorageProvider([StorageReference storage, Uuid uuid]) diff --git a/lib/src/resources/firestore_provider.dart b/lib/src/resources/firestore_provider.dart index 504f68e..205c3e8 100644 --- a/lib/src/resources/firestore_provider.dart +++ b/lib/src/resources/firestore_provider.dart @@ -64,7 +64,7 @@ class FirestoreProvider { ); } - /// Creates a new instance of a user in Firestore. + /// Creates a new user in Firestore. Future createUser(UserModel user, String uid) async { try { final dataMap = user.toFirestoreMap(); diff --git a/lib/src/resources/google_sign_in_provider.dart b/lib/src/resources/google_sign_in_provider.dart index 09bdf4d..2a9c4b4 100644 --- a/lib/src/resources/google_sign_in_provider.dart +++ b/lib/src/resources/google_sign_in_provider.dart @@ -6,7 +6,7 @@ import 'package:rxdart/rxdart.dart'; export 'package:firebase_auth/firebase_auth.dart' show FirebaseUser; -/// A Google authentication provider. +/// Google authentication provider. /// /// Connects to both Google and Firebase to authenticate a user. class GoogleSignInProvider {