diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index 1ae129a3a28..36e82dffd2a 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -165,12 +165,11 @@ the `Logic` component as the other commands described above. However, during execution, tasks commands may update the context of the current tasks of a team. To understand tasks better, it should be understood that Tasks are an attribute of a Teams object, which is used to indicate if a tasks is done (also known as marked), -or not (also known as unmarked). +or not (also known as unmarked). Moreover, progress of each task can be tracked with specific levels (namely 25%, 50%, 75% and 100 %). +Below is the class diagram that illustrates the interactions between Logic and Model components, in relation to tasks. -The Sequence Diagram below shows the interaction between `Logic` and `Model` components when `execute("at ..")` is called. - -[insert Sequence Diagram] +![Interactions Inside the Logic Component for the `cg ..` Command](images/TaskClassDiagram.png) This way of implementation of maintains abstraction of details of the `Logic` component, in the `Model` component. diff --git a/docs/UserGuide.md b/docs/UserGuide.md index 96005413c39..28de38299e1 100644 --- a/docs/UserGuide.md +++ b/docs/UserGuide.md @@ -238,6 +238,21 @@ Example: This sets the status of the `Generate report` task in the `Accountants` team to Sep 13, 2022 at 10:20am UTC time. +### Set progress for tasks: `task progress` + +Sets the progress level for each task that has been listed. + +Format: `task progress i/ ` + +- Index indicates the index of the task in the list +- Level indicates the progress level, and can only be set to 25%, 50%, 75%, 100% + +Example: +- `task progress 1 25%` + +This sets the progress of the first task in the list as 25% + + ## FAQ > How can I install `Java 11`? diff --git a/docs/images/TaskClassDiagram.png b/docs/images/TaskClassDiagram.png new file mode 100644 index 00000000000..a1766bd5471 Binary files /dev/null and b/docs/images/TaskClassDiagram.png differ