Fixes comments, some code style

Change-Id: I5c8d7ea2528f0b30d6994e2ea6e25a5e9dda8f6b

Author: JoseAlcerreca

app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/TasksDataSource.kt

@@ -19,12 +19,6 @@ import com.example.android.architecture.blueprints.todoapp.data.Result
 import com.example.android.architecture.blueprints.todoapp.data.Task
 /**
  * Main entry point for accessing tasks data.
- *
- *
- * For simplicity, only getTasks() and getTask() have callbacks. Consider adding callbacks to other
- * methods to inform the user of network/database errors or successful operations.
- * For example, when a new task is created, it's synchronously stored in cache but usually every
- * operation on database or network should be executed in a different thread.
  */
 interface TasksDataSource {
 

app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/TasksRepository.kt

@@ -19,6 +19,9 @@ package com.example.android.architecture.blueprints.todoapp.data.source
 import com.example.android.architecture.blueprints.todoapp.data.Result
 import com.example.android.architecture.blueprints.todoapp.data.Task
 
+/**
+ * Interface to the data layer.
+ */
 interface TasksRepository {
 
     suspend fun getTasks(forceUpdate: Boolean = false): Result<List<Task>>
@@ -40,4 +43,4 @@ interface TasksRepository {
     suspend fun deleteAllTasks()
 
     suspend fun deleteTask(taskId: String)
-}
+}

app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/TasksLocalDataSource.kt

@@ -62,17 +62,15 @@ class TasksLocalDataSource internal constructor(
     }
 
     override suspend fun completeTask(taskId: String) {
-        // Not required for the local data source because the {@link DefaultTasksRepository} handles
-        // converting from a {@code taskId} to a {@link task} using its cached data.
+        tasksDao.updateCompleted(taskId, true)
     }
 
     override suspend fun activateTask(task: Task) = withContext(ioDispatcher) {
         tasksDao.updateCompleted(task.id, false)
     }
 
     override suspend fun activateTask(taskId: String) {
-        // Not required for the local data source because the {@link DefaultTasksRepository} handles
-        // converting from a {@code taskId} to a {@link task} using its cached data.
+        tasksDao.updateCompleted(taskId, false)
     }
 
     override suspend fun clearCompletedTasks() = withContext<Unit>(ioDispatcher) {

app/src/main/java/com/example/android/architecture/blueprints/todoapp/data/source/local/ToDoDatabase.kt

@@ -22,9 +22,11 @@ import com.example.android.architecture.blueprints.todoapp.data.Task
 
 /**
  * The Room Database that contains the Task table.
+ *
+ * Note that exportSchema should be true in production databases.
  */
 @Database(entities = [Task::class], version = 1, exportSchema = false)
 abstract class ToDoDatabase : RoomDatabase() {
 
     abstract fun taskDao(): TasksDao
-}
+}

app/src/main/java/com/example/android/architecture/blueprints/todoapp/statistics/StatisticsViewModel.kt

@@ -27,13 +27,7 @@ import com.example.android.architecture.blueprints.todoapp.util.wrapEspressoIdli
 import kotlinx.coroutines.launch
 
 /**
- * Exposes the data to be used in the statistics screen.
- *
- *
- * This ViewModel uses both [ObservableField]s ([ObservableBoolean]s in this case) and
- * [Bindable] getters. The values in [ObservableField]s are used directly in the layout,
- * whereas the [Bindable] getters allow us to add some logic to it. This is
- * preferable to having logic in the XML layout.
+ * ViewModel for the statistics screen.
  */
 class StatisticsViewModel(
     private val tasksRepository: TasksRepository

app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksActivity.kt

@@ -28,6 +28,9 @@ import androidx.navigation.ui.setupWithNavController
 import com.example.android.architecture.blueprints.todoapp.R
 import com.google.android.material.navigation.NavigationView
 
+/**
+ * Main activity for the todoapp. Holds the Navigation Host Fragment and the Drawer, Toolbar, etc.
+ */
 class TasksActivity : AppCompatActivity() {
 
     private lateinit var drawerLayout: DrawerLayout
@@ -39,18 +42,19 @@ class TasksActivity : AppCompatActivity() {
         setupNavigationDrawer()
         setSupportActionBar(findViewById(R.id.toolbar))
 
-        val navController : NavController = findNavController(R.id.nav_host_fragment)
+        val navController: NavController = findNavController(R.id.nav_host_fragment)
         appBarConfiguration =
             AppBarConfiguration.Builder(R.id.tasksFragment, R.id.statisticsFragment)
                 .setDrawerLayout(drawerLayout)
                 .build()
         setupActionBarWithNavController(navController, appBarConfiguration)
         findViewById<NavigationView>(R.id.nav_view)
-          .setupWithNavController(navController)
+            .setupWithNavController(navController)
     }
 
     override fun onSupportNavigateUp(): Boolean {
-        return findNavController(R.id.nav_host_fragment).navigateUp(appBarConfiguration) || super.onSupportNavigateUp()
+        return findNavController(R.id.nav_host_fragment).navigateUp(appBarConfiguration)
+            || super.onSupportNavigateUp()
     }
 
     private fun setupNavigationDrawer() {
@@ -64,4 +68,4 @@ class TasksActivity : AppCompatActivity() {
 // Keys for navigation
 const val ADD_EDIT_RESULT_OK = Activity.RESULT_FIRST_USER + 1
 const val DELETE_RESULT_OK = Activity.RESULT_FIRST_USER + 2
-const val EDIT_RESULT_OK = Activity.RESULT_FIRST_USER + 3
+const val EDIT_RESULT_OK = Activity.RESULT_FIRST_USER + 3

app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksAdapter.kt

@@ -24,6 +24,9 @@ import com.example.android.architecture.blueprints.todoapp.data.Task
 import com.example.android.architecture.blueprints.todoapp.databinding.TaskItemBinding
 import com.example.android.architecture.blueprints.todoapp.tasks.TasksAdapter.ViewHolder
 
+/**
+ * Adapter for the task list. Has a reference to the [TasksViewModel] to send actions back to it.
+ */
 class TasksAdapter(private val viewModel: TasksViewModel) :
     ListAdapter<Task, ViewHolder>(TaskDiffCallback()) {
 

app/src/main/java/com/example/android/architecture/blueprints/todoapp/tasks/TasksViewModel.kt

@@ -33,12 +33,7 @@ import kotlinx.coroutines.launch
 import java.util.ArrayList
 
 /**
- * Exposes the data to be used in the task list screen.
- *
- *
- * [BaseObservable] implements a listener registration mechanism which is notified when a
- * property changes. This is done by assigning a [Bindable] annotation to the property's
- * getter method.
+ * ViewModel for the task list screen.
  */
 class TasksViewModel(
     private val tasksRepository: TasksRepository