Skip to content

Commit

Permalink
Merge pull request #280 from AY2324S1-CS2103T-F08-0/fry-update-ppp
Browse files Browse the repository at this point in the history
Update DG
  • Loading branch information
xxiaoweii authored Nov 13, 2023
2 parents 5c54961 + 7388927 commit 038cc81
Show file tree
Hide file tree
Showing 7 changed files with 536 additions and 29 deletions.
239 changes: 215 additions & 24 deletions docs/DeveloperGuide.md

Large diffs are not rendered by default.

71 changes: 71 additions & 0 deletions docs/diagrams/DeletePersonSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,71 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":DeleteCommandParser" as DeleteCommandParser LOGIC_COLOR
participant "d:DeleteCommand" as DeleteCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("delete 1")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("delete 1")
activate AddressBookParser

create DeleteCommandParser
AddressBookParser -> DeleteCommandParser
activate DeleteCommandParser

DeleteCommandParser --> AddressBookParser
deactivate DeleteCommandParser

AddressBookParser -> DeleteCommandParser : parse("1")
activate DeleteCommandParser

create DeleteCommand
DeleteCommandParser -> DeleteCommand
activate DeleteCommand

DeleteCommand --> DeleteCommandParser : d
deactivate DeleteCommand

DeleteCommandParser --> AddressBookParser : d
deactivate DeleteCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
DeleteCommandParser -[hidden]-> AddressBookParser
destroy DeleteCommandParser

AddressBookParser --> LogicManager : d
deactivate AddressBookParser

LogicManager -> DeleteCommand : execute()
activate DeleteCommand

DeleteCommand -> Model : deletePerson(personToDelete)
activate Model

Model --> DeleteCommand
deactivate Model

create CommandResult
DeleteCommand -> CommandResult
activate CommandResult

CommandResult --> DeleteCommand
deactivate CommandResult

DeleteCommand --> LogicManager : result
deactivate DeleteCommand

[<--LogicManager
deactivate LogicManager
@enduml
84 changes: 84 additions & 0 deletions docs/diagrams/EditPersonSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":EditCommandParser" as EditCommandParser LOGIC_COLOR
participant "d:EditCommand" as EditCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
participant "e:Person" as EditedPerson MODEL_COLOR
end box

[-> LogicManager : execute("edit 1 --name new name")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("edit 1 --name new name")
activate AddressBookParser

create EditCommandParser
AddressBookParser -> EditCommandParser
activate EditCommandParser

EditCommandParser --> AddressBookParser
deactivate EditCommandParser

AddressBookParser -> EditCommandParser : parse("1 --name new name")
activate EditCommandParser

create EditCommand
EditCommandParser -> EditCommand
activate EditCommand

EditCommand --> EditCommandParser : d
deactivate EditCommand

EditCommandParser --> AddressBookParser : d
deactivate EditCommandParser
'Hidden arrow to position the destroy marker below the end of the activation bar.
EditCommandParser -[hidden]-> AddressBookParser
destroy EditCommandParser

AddressBookParser --> LogicManager : d
deactivate AddressBookParser

LogicManager -> EditCommand : execute()
activate EditCommand

create EditedPerson
EditCommand -> EditedPerson ++
return

EditCommand -> Model ++ : hasPerson(e)
return

EditCommand -> Model : setPerson(p, e)
activate Model

Model --> EditCommand
deactivate Model

EditCommand -> Model : updateFilteredPersonList()
activate Model

Model --> EditCommand
deactivate Model

create CommandResult
EditCommand -> CommandResult
activate CommandResult

CommandResult --> EditCommand
deactivate CommandResult

EditCommand --> LogicManager : result
deactivate EditCommand

[<--LogicManager
deactivate LogicManager
@enduml
79 changes: 79 additions & 0 deletions docs/diagrams/FavouritePersonSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":FavouriteCommandParser" as FavouriteCommandParser LOGIC_COLOR
participant "d:FavouriteCommand" as FavouriteCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("fav 1")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("fav 1")
activate AddressBookParser

create FavouriteCommandParser
AddressBookParser -> FavouriteCommandParser
activate FavouriteCommandParser

FavouriteCommandParser --> AddressBookParser
deactivate FavouriteCommandParser

AddressBookParser ->FavouriteCommandParser : parse("1")
activate FavouriteCommandParser

create FavouriteCommand
FavouriteCommandParser -> FavouriteCommand
activate FavouriteCommand

FavouriteCommand --> FavouriteCommandParser : d
deactivate FavouriteCommand

FavouriteCommandParser --> AddressBookParser : d
deactivate FavouriteCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
FavouriteCommandParser -[hidden]-> AddressBookParser
destroy FavouriteCommandParser

AddressBookParser --> LogicManager : d
deactivate AddressBookParser

LogicManager -> FavouriteCommand : execute()
activate FavouriteCommand

FavouriteCommand -> Model : favouritePerson(personToFavourite)
activate Model

Model --> FavouriteCommand
deactivate Model

FavouriteCommand -> Model ++ : setPerson(personToFavourite, personToFavourite)
return

FavouriteCommand -> Model ++ : updateFilteredPersonList()
return

deactivate Model

create CommandResult
FavouriteCommand -> CommandResult
activate CommandResult

CommandResult --> FavouriteCommand
deactivate CommandResult

FavouriteCommand --> LogicManager : result
deactivate FavouriteCommand

[<--LogicManager
deactivate LogicManager
@enduml
79 changes: 79 additions & 0 deletions docs/diagrams/UnfavouritePersonSequenceDiagram.puml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
@startuml
!include style.puml
skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":UnfavouriteCommandParser" as UnfavouriteCommandParser LOGIC_COLOR
participant "d:UnfavouriteCommand" as UnfavouriteCommand LOGIC_COLOR
participant ":CommandResult" as CommandResult LOGIC_COLOR
end box

box Model MODEL_COLOR_T1
participant ":Model" as Model MODEL_COLOR
end box

[-> LogicManager : execute("unfav 1")
activate LogicManager

LogicManager -> AddressBookParser : parseCommand("unfav 1")
activate AddressBookParser

create UnfavouriteCommandParser
AddressBookParser -> UnfavouriteCommandParser
activate UnfavouriteCommandParser

UnfavouriteCommandParser --> AddressBookParser
deactivate UnfavouriteCommandParser

AddressBookParser ->UnfavouriteCommandParser : parse("1")
activate UnfavouriteCommandParser

create UnfavouriteCommand
UnfavouriteCommandParser -> UnfavouriteCommand
activate UnfavouriteCommand

UnfavouriteCommand --> UnfavouriteCommandParser : d
deactivate UnfavouriteCommand

UnfavouriteCommandParser --> AddressBookParser : d
deactivate UnfavouriteCommandParser

'Hidden arrow to position the destroy marker below the end of the activation bar.
UnfavouriteCommandParser -[hidden]-> AddressBookParser
destroy UnfavouriteCommandParser

AddressBookParser --> LogicManager : d
deactivate AddressBookParser

LogicManager -> UnfavouriteCommand : execute()
activate UnfavouriteCommand

UnfavouriteCommand -> Model : unfavouritePerson(personToUnfavourite)
activate Model

Model --> UnfavouriteCommand
deactivate Model

UnfavouriteCommand -> Model ++ : setPerson(personToUnfavourite, personToUnfavourite)
return

UnfavouriteCommand -> Model ++ : updateFilteredPersonList()
return

deactivate Model

create CommandResult
UnfavouriteCommand -> CommandResult
activate CommandResult

CommandResult --> UnfavouriteCommand
deactivate CommandResult

UnfavouriteCommand --> LogicManager : result
deactivate UnfavouriteCommand

[<--LogicManager
deactivate LogicManager
@enduml
11 changes: 7 additions & 4 deletions docs/team/frrrrry.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,8 @@ Given below are my contributions to the project.
##### Project management
* Created team organization, team repository, and set up repository with MarkBind and Codecov
* Created milestones (v1.1, v1.2, v1.3, v1.3b & v1.4)
* Added 40 issues for all milestones.
* Added a total of 45 issues for all milestones.
Click [here](https://github.com/AY2324S1-CS2103T-F08-0/tp/issues?q=is%3Aissue+is%3Aclosed+author%3Afrrrrry) to view the issues.
* Assigned issues(tasks) to team members for all milestones.
* Filtered out and labelled all PE-D bug reports with the labels "bug.mustFix", "bug.goodToFix", "bug.duplicate",
"bug.wontFix", "bug.notAllowedToFix", required for bug triaging and submission for v1.4.
Expand All @@ -40,14 +41,16 @@ Given below are my contributions to the project.
* User Guide:
* Added section - A guide to reading each command
* Added section - Clearing the person list: `clear`
* Created the structure for all the section - Features
* Created the structure for the section - Features
* Formatted the heading levels and order of the sections
* Created command summary table
* Developer Guide:
* Add content page
* Edited the class diagram for Storage.
* Added implementation of the delete, favourite, and unfavourite features
* Added proposed implementation of the edit feature
* Added product scope
* Added user stories
* Edited the class diagram for Storage.
* Added implementation of the favourite feature

##### Team Tasks
* Set up team organization and repository
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/seedu/address/MainApp.java
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@
*/
public class MainApp extends Application {

public static final Version VERSION = new Version(1, 3, 1, true);
public static final Version VERSION = new Version(1, 4, 1, true);

private static final Logger logger = LogsCenter.getLogger(MainApp.class);

Expand Down

0 comments on commit 038cc81

Please sign in to comment.