Skip to content

Commit

Permalink
Fix minor UML errors and remove placeholders
Browse files Browse the repository at this point in the history
  • Loading branch information
leeweiming3 committed Apr 14, 2024
1 parent fe14ae5 commit 108ac06
Show file tree
Hide file tree
Showing 7 changed files with 7 additions and 10 deletions.
7 changes: 1 addition & 6 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -334,7 +334,7 @@ Step 3. `TagCommandParser#parse(String)` creates a new `TagCommand` object, whic

Step 4.`TagCommand#execute(Model)` is then called in `LogicManager#execute(String)`, where the matching `Person` is found and the union of tags present and tags to add is calculated. A new person is created using the tag union and the old person's data. Then, the old person is updated in the person list with `ModelManager#setPerson(Person, Person)`, the filtered person list in the model is updated with `ModelManager#updateFilteredPersonList(Predicate<Person>)`, and the applications in the application list are updated to contain the edited person with `ModelManager#replaceApplications(Person, Person)`.

The following sequence diagram shows how a add_app operation goes through the various components:
The following sequence diagram shows how a tag operation goes through the various components:

![TagSequenceDiagram](images/TagSequenceDiagram.png)

Expand Down Expand Up @@ -420,11 +420,6 @@ The following activity diagram summarizes what happens when a user executes a ne
* Pros: Will use less memory (e.g. for `delete`, just save the person being deleted).
* Cons: We must ensure that the implementation of each individual command are correct.

_{more aspects and alternatives to be added}_

### \[Proposed\] Data archiving

_{Explain here how the data archiving feature will be implemented}_


--------------------------------------------------------------------------------------------------------------------
Expand Down
5 changes: 4 additions & 1 deletion docs/diagrams/LogicClassDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Class "{abstract}\nCommand" as Command
Class "{abstract}\nConfirmableCommand" as ConfirmableCommand
Class "{abstract}\nAbstractDeleteCommand" as ADCommand
Class XYZDeleteCommand
Enum "<<enumeration>>\nCommandBoxState" as CommandBoxState

Class "<<interface>>\nLogic" as Logic
Class LogicManager
Expand All @@ -30,7 +31,7 @@ Class HiddenOutside #FFFFFF
HiddenOutside ..> Logic

LogicManager .right.|> Logic
LogicManager -left->"1" ParserClasses
LogicManager -left->"2" ParserClasses
ParserClasses ..> XYZCommand : <<create>>
ParserClasses ..>XYZDeleteCommand : <<create>>

Expand All @@ -39,6 +40,8 @@ LogicManager .left.> Command : <<call>>

LogicManager --> Model
LogicManager --> Storage
CommandBoxState -right[hidden]->CommandResult
LogicManager -> CommandBoxState
Storage --[hidden] Model
Command .[hidden]up.> Storage
Command .right.> Model
Expand Down
4 changes: 2 additions & 2 deletions docs/diagrams/ParserClasses.puml
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,8 @@ HiddenOutside ..> ConfirmationStageParser
HiddenOutside ..> AddressBookParser
AddressBookParser .down.> XYZCommandParser: <<create>>

ConfirmationStageParser ..> Command: <<confirm>>
ConfirmationStageParser ..> Command: <<deny>>
ConfirmationStageParser --> Command: <<confirm>>
ConfirmationStageParser --> Command: <<deny>>
XYZCommandParser ..> XYZCommand : <<create>>
AddressBookParser ..> Command : <<use>>
XYZCommandParser .up.|> Parser
Expand Down
1 change: 0 additions & 1 deletion docs/diagrams/SearchSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,6 @@ deactivate SearchPersonDescriptor

create SearchCommand
SearchCommandParser -> SearchCommand
activate SearchCommandCommand


SearchCommand --> SearchCommandParser
Expand Down
Binary file modified docs/images/LogicClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/ParserClasses.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/images/SearchSequenceDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 108ac06

Please sign in to comment.