Merge pull request #314 from songfangyl/branch-Update-DevGuide

Update UML diagram
AY2324S1-CS2103T-W16-2 · Nov 12, 2023 · 4e13827 · 4e13827
2 parents 705a443 + 71c5045
commit 4e13827
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 12 deletions.
diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md
@@ -340,7 +340,7 @@ It tests each customer in the list with given `keywords`(search prompt given by
 ###### **Implementing `PersonContainsKeywordsPredicate`**
 
 This class serves as the primary predicate for testing multiple conditions. It houses various predicates such as
-'NameContainsKeywordsPredicate' to check if specific criteria are met.
+`NameContainsKeywordsPredicate` to check if specific criteria are met.
 
 <div style="page-break-after: always;"></div>
 
@@ -660,6 +660,9 @@ Taking `parse("2 he likes pizza")`as an example.
 
 The class is responsible in executing the task parsed by the `RemarkCommandParser`.
 It will update the `Remark` of a `Person` and generate a `CommandResult` for the output.
+Below is the class diagram of the `RemarkCommand` class.
+
+<puml src="diagrams/remark-feature/RemarkClass.puml"/>
 
 ### Design Consideration:
 

diff --git a/docs/diagrams/find-feature/ExecuteFindCommandSequenceDiagram.puml b/docs/diagrams/find-feature/ExecuteFindCommandSequenceDiagram.puml
@@ -12,13 +12,14 @@ end box
 
 [-> command : execute(m)
 |||
-command -> model : m.updateFilterPersonList(personPredicate)
+command -> model : updateFilterPersonList(personPredicate)
 |||
-command -> model : m.getFilteredPersonList().size()
-return size
+command -> model : getFilteredPersonList()
+|||
+return
 |||
 create result
-command -> result : new CommandResult(size)
+command -> result
 activate result
 return result
 

diff --git a/docs/diagrams/find-feature/ParseFindCommandSequenceDiagram.puml b/docs/diagrams/find-feature/ParseFindCommandSequenceDiagram.puml
@@ -36,13 +36,13 @@ return r
 return r
 |||
 create personPredicate
-parser -> personPredicate : new PersonContainsKeywordsPredicate(n, r)
+parser -> personPredicate : PersonContainsKeywordsPredicate(n, r)
 |||
 activate personPredicate
 return p
 
 create command
-parser -> command : new FindCommand(p)
+parser -> command : FindCommand(p)
 activate command
 |||
 return command

diff --git a/docs/diagrams/add-remark/ParserClass.puml → .../diagrams/remark-feature/ParserClass.puml b/docs/diagrams/add-remark/ParserClass.puml → .../diagrams/remark-feature/ParserClass.puml
diff --git a/docs/diagrams/add-remark/RemarkClass.puml → .../diagrams/remark-feature/RemarkClass.puml b/docs/diagrams/add-remark/RemarkClass.puml → .../diagrams/remark-feature/RemarkClass.puml
@@ -8,8 +8,8 @@ Class "{abstract}\nCommand" as Command {
 Class RemarkCommand {
   +COMMAND_WORD: String
   +MESSAGE_USAGE: String
-  +MESSAGE_NOT_IMPLEMENTED_YET: String
-  +execute(Model): CommandResult
+  +MESSAGE_ADD_REMARK_SUCCESS: String
+  +MESSAGE_DELETE_REMARK_SUCCESS: String
 }
 Class CommandException
 

diff --git a/docs/diagrams/remark-feature/RemarkCommandParserSequenceDiagram.puml b/docs/diagrams/remark-feature/RemarkCommandParserSequenceDiagram.puml
@@ -13,13 +13,13 @@ end
 |||
 alt empty argument
     create emptyRemark
-    RemarkCommandParser --> emptyRemark : new Remark("")
+    RemarkCommandParser --> emptyRemark : Remark("")
     activate emptyRemark
     return e
 |||
 else
     create remark
-    RemarkCommandParser --> remark : new Remark(argument)
+    RemarkCommandParser --> remark : Remark(argument)
     activate remark
     return r
 end
@@ -28,7 +28,7 @@ create RemarkCommand
 RemarkCommandParser --> RemarkCommand
 activate RemarkCommand
 |||
-return : command
+return command
 
 [<--RemarkCommandParser : command