From a1ca34495e909cce0fad23e3a666998e0824bda7 Mon Sep 17 00:00:00 2001
From: AYM1607 <u.g.a.mariano@gmail.com>
Date: Fri, 5 Apr 2019 15:15:06 -0600
Subject: [PATCH] Added docs for the services

---
 lib/src/services/auth_service.dart         | 14 ++++++++++++++
 lib/src/services/current_task_service.dart |  4 ++++
 2 files changed, 18 insertions(+)

diff --git a/lib/src/services/auth_service.dart b/lib/src/services/auth_service.dart
index 19f9a5c..e0341e7 100644
--- a/lib/src/services/auth_service.dart
+++ b/lib/src/services/auth_service.dart
@@ -10,11 +10,20 @@ import '../models/user_model.dart';
 export '../resources/google_sign_in_provider.dart' show FirebaseUser;
 
 class AuthService {
+  /// An instance of [GoogleSignInProvider].
   final GoogleSignInProvider _googleSignInProvider = signInProvider;
+
+  /// An instance of the firestore provider.
   final FirestoreProvider _firestoreProvider = firestoreProvider;
+
+  /// A subject of Firebase user.
   final _user = BehaviorSubject<FirebaseUser>();
 
+  // Stream getters.
+  /// An observable of the current [FirebaseUser]
   Observable<FirebaseUser> get userStream => _user.stream;
+
+  /// A future of the current [FirebaseUser].
   Future<FirebaseUser> get currentUser =>
       _googleSignInProvider.getCurrentUser();
 
@@ -22,6 +31,10 @@ class AuthService {
     _googleSignInProvider.onAuthStateChange.pipe(_user);
   }
 
+  /// Logs in or Signs up a user.
+  ///
+  /// Checks if the account used to sign up is already registered, log the user
+  /// in if it is, create a new user otherwise.
   Future<FirebaseUser> googleLoginAndSignup() async {
     final user = await _googleSignInProvider.signIn();
 
@@ -45,6 +58,7 @@ class AuthService {
     return user;
   }
 
+  /// Sings out the current user.
   Future<void> signOut() {
     return _googleSignInProvider.signOut();
   }
diff --git a/lib/src/services/current_task_service.dart b/lib/src/services/current_task_service.dart
index 4360a57..598eda0 100644
--- a/lib/src/services/current_task_service.dart
+++ b/lib/src/services/current_task_service.dart
@@ -1,10 +1,14 @@
 import '../models/task_model.dart';
 
+/// A service that keeps track of the current selected task.
 class CurrentTaskService {
+  /// The current selected task.
   TaskModel _currentTask;
 
+  /// The current selected task.
   TaskModel get task => _currentTask;
 
+  /// Sets the current selected task.
   void setTask(TaskModel newTask) {
     _currentTask = newTask;
   }