From 3b2c293dc3bcc52f9edb5e4a638a90a5cc370119 Mon Sep 17 00:00:00 2001 From: AYM1607 Date: Fri, 5 Apr 2019 13:34:27 -0600 Subject: [PATCH] Added docs for the summary model --- lib/src/models/summary_model.dart | 22 +++++++++++++++++++++- 1 file changed, 21 insertions(+), 1 deletion(-) diff --git a/lib/src/models/summary_model.dart b/lib/src/models/summary_model.dart index 9e9e172..f1c6b56 100644 --- a/lib/src/models/summary_model.dart +++ b/lib/src/models/summary_model.dart @@ -2,15 +2,34 @@ /// /// It represents how many tasks were completed and added by a user every day. class SummaryModel { + /// Amount of tasks completed on Monday. int completedMonday; + + /// Amount od tasks added on Monday. int addedMonday; + + /// Amount of tasks completed on Tuesday. int completedTuesday; + + /// Amount od tasks added on Tuesday. int addedTuesday; + + /// Amount of tasks completed on Wednesday. int completedWednesday; + + /// Amount od tasks added on Wednesday. int addedWednesday; + + /// Amount of tasks completed on Thursday. int completedThursday; + + /// Amount od tasks added on Thursday. int addedThursday; + + /// Amount of tasks completed on Friday. int completedFriday; + + /// Amount od tasks added on Friday. int addedFriday; SummaryModel({ @@ -26,7 +45,7 @@ class SummaryModel { this.addedFriday = 0, }); - /// Returns a [SummaryModel] from a map. + /// Creates a [SummaryModel] from a map. SummaryModel.fromMap(Map map) { completedMonday = map["completedMonday"]; addedMonday = map["addedMonday"]; @@ -40,6 +59,7 @@ class SummaryModel { addedFriday = map["addedFriday"]; } + /// Returns a map representation of the model. Map toMap() { return { "completedMonday": completedMonday,