From 73f7d1cec19004209e97e68eec1602c5a2f7ef62 Mon Sep 17 00:00:00 2001 From: tohlh Date: Mon, 15 Apr 2024 21:20:16 +0800 Subject: [PATCH] Update DeveloperGuide.md --- docs/DeveloperGuide.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index d49c22519ba..58fe9007e75 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -386,6 +386,8 @@ The result message is then displayed to the user via the GUI. The attendance tab The following sequence diagram illustrates how the `mark` mechanism works: +
+ The following activity diagram summarizes what happens when a user executes the `mark` command: @@ -440,6 +442,8 @@ Given below is the example usage scenario and how the add group mechanism behave 9. Finally, the `AddGroupCommand` creates a `CommandResult` with a success message and return it to the `LogicManager` to complete the command execution. The GUI would also be updated on this change and created a new dedicated group tab for this new group added. +
+ The following sequence diagram shows how the `addgroup` mechanism works: @@ -499,6 +503,8 @@ The following sequence diagram shows how the `editgroup` mechanism works: +
+ The following activity diagram summarizes what happens when a user executes the `editgroup` command: @@ -553,6 +559,8 @@ Given below is the example usage scenario and how the delete group mechanism beh 10. Finally, the `DeleteGroupCommand` creates a `CommandResult` with a success message and return it to the `LogicManager` to complete the command execution. The GUI would also be updated on this change and remove the dedicated group tab for the group deleted. +
+ The following sequence diagram shows how the `deletegroup` mechanism works: @@ -604,6 +612,8 @@ The user inputs the `mail` command followed by optional keywords specifying grou The Mail Command feature provides an efficient way for users to compose emails to specific groups of students directly from the application. By leveraging the power of filtering, it allows for targeted communication while maintaining simplicity and ease of use. +
+ The following sequence diagram illustrates how the `mail` mechanism works: @@ -653,6 +663,8 @@ The user inputs the `mailtg` command followed by the `/g` prefix and the keyword The Mailtg Command feature provides an efficient way for users to compose emails to specific groups of students directly from the application. By leveraging the power of filtering, it allows for targeted communication while maintaining simplicity and ease of use. +
+ The following sequence diagram illustrates how the `mailtg` mechanism works: @@ -1437,6 +1449,7 @@ Given below are the planned enhancements for the application. 8. **Make filter feature error message more specific**: When filtered with a non-existing group, the current error message displays`0 students listed!` which is too general. We plan to `filter` command check whether the `GROUP_NAME` provided is an existing group. The error message will then also mention the reason for failing to filter any students: `Group does not exist, 0 students listed!` +
## **Appendix: Effort**