diff --git a/docs/DeveloperGuide.md b/docs/DeveloperGuide.md index c7495d9bfd2..ea8e339a1b9 100644 --- a/docs/DeveloperGuide.md +++ b/docs/DeveloperGuide.md @@ -246,8 +246,6 @@ The following activity diagram shows how the AddTag operation works: The following sequence diagram shows how the AddTag operation works: -The - ### DeleteTag feature @@ -412,7 +410,11 @@ Given below is an example usage scenario and how the View Policy mechanism behav 5. The `CommandResult` is then returned by the `execute` method with the `toString()` of the `policy` indexed from the previous step 6. The UI will display the details of the policy specified by the index and a success message is displayed on the UI +The following activity diagram for viewing policy of a particular Client: + + The following sequence diagram shows how the View Policy operation works: + ### Filter Policy Description feature @@ -432,7 +434,7 @@ Given below is an example usage scenario and how the Filter Policy mechanism beh 8. This object will then be passed to `Logic`. 9. The execution will then be over as the updated list of filtered `Person` objects are displayed on the Ui -The following sequence diagram shows how the Filter Policy Description operation works: +The following activity diagram shows how the Filter Policy Description operation works: ### Toggle Mode feature diff --git a/docs/diagrams/ViewPolicyActivityDiagram.png b/docs/diagrams/ViewPolicyActivityDiagram.png new file mode 100644 index 00000000000..2d6e14d0c83 Binary files /dev/null and b/docs/diagrams/ViewPolicyActivityDiagram.png differ diff --git a/docs/diagrams/ViewPolicyActivityDiagram.puml b/docs/diagrams/ViewPolicyActivityDiagram.puml new file mode 100644 index 00000000000..b20220bc6f3 --- /dev/null +++ b/docs/diagrams/ViewPolicyActivityDiagram.puml @@ -0,0 +1,19 @@ +@startuml +skin rose +skinparam ActivityFontSize 15 +skinparam ArrowFontSize 12 +start +:User executes ViewPolicyCommand; + +'Since the beta syntax does not support placing the condition outside the +'diamond we place it as the true branch instead. + +if () then ([user keys in valid command format]) + :Displays information about policy the user wants to view; +else ([else]) + :Display invalid command format error; +stop +endif +:Display success message; +stop +@enduml diff --git a/docs/diagrams/ViewPolicySequenceDiagram.png b/docs/diagrams/ViewPolicySequenceDiagram.png new file mode 100644 index 00000000000..22e57b58f56 Binary files /dev/null and b/docs/diagrams/ViewPolicySequenceDiagram.png differ diff --git a/docs/diagrams/ViewPolicySequenceDiagram.puml b/docs/diagrams/ViewPolicySequenceDiagram.puml new file mode 100644 index 00000000000..986c5e91585 --- /dev/null +++ b/docs/diagrams/ViewPolicySequenceDiagram.puml @@ -0,0 +1,77 @@ +@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 ":ViewPolicyCommandParser" as ViewPolicyCommandParser LOGIC_COLOR +participant "v:ViewPolicyCommand" as ViewPolicyCommand 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("viewPolicy 1 1") +activate LogicManager + +LogicManager -> AddressBookParser : parseCommand("viewPolicy 1 1") +activate AddressBookParser + +create ViewPolicyCommandParser +AddressBookParser -> ViewPolicyCommandParser +activate ViewPolicyCommandParser + +ViewPolicyCommandParser --> AddressBookParser +deactivate ViewPolicyCommandParser + +AddressBookParser -> ViewPolicyCommandParser : parse("1 1") +activate ViewPolicyCommandParser + +create ViewPolicyCommand +ViewPolicyCommandParser -> ViewPolicyCommand +activate ViewPolicyCommand + +ViewPolicyCommand --> ViewPolicyCommandParser : v +deactivate ViewPolicyCommand + +ViewPolicyCommandParser --> AddressBookParser : v +deactivate ViewPolicyCommandParser +'Hidden arrow to position the destroy marker below the end of the activation bar. +ViewPolicyCommandParser -[hidden]-> AddressBookParser +destroy ViewPolicyCommandParser + +AddressBookParser --> LogicManager : v +deactivate AddressBookParser + +LogicManager -> ViewPolicyCommand : execute(model) +activate ViewPolicyCommand + +ViewPolicyCommand -> Model : get(1) +activate Model + +Model --> ViewPolicyCommand +deactivate Model + +ViewPolicyCommand -> Model : getPolicies() +activate Model + +Model --> ViewPolicyCommand +deactivate Model + + +create CommandResult +ViewPolicyCommand -> CommandResult +activate CommandResult + +CommandResult --> ViewPolicyCommand +deactivate CommandResult + +ViewPolicyCommand --> LogicManager : result +deactivate ViewPolicyCommand + +[<--LogicManager +deactivate LogicManager +@enduml diff --git a/docs/team/aarontxz.md b/docs/team/aarontxz.md index a99c0c48c2a..1a606d9981f 100644 --- a/docs/team/aarontxz.md +++ b/docs/team/aarontxz.md @@ -5,11 +5,11 @@ ### Project: Insurahub -Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers CLI over GUI to use the app. -The application is mainly used by financial advisors in their day to day planning and scheduling of meetings with clients, +Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app. +The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients, assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub. -While Insurahub have limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place. +While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place. Given below are my contributions to the project. diff --git a/docs/team/johndoe.md b/docs/team/johndoe.md deleted file mode 100644 index 86aa7ebfc34..00000000000 --- a/docs/team/johndoe.md +++ /dev/null @@ -1,46 +0,0 @@ ---- - layout: default.md - title: "John Doe's Project Portfolio Page" ---- - -### Project: AddressBook Level 3 - -AddressBook - Level 3 is a desktop address book application used for teaching Software Engineering principles. The user interacts with it using a CLI, and it has a GUI created with JavaFX. It is written in Java, and has about 10 kLoC. - -Given below are my contributions to the project. - -* **New Feature**: Added the ability to undo/redo previous commands. - * What it does: allows the user to undo all previous commands one at a time. Preceding undo commands can be reversed by using the redo command. - * Justification: This feature improves the product significantly because a user can make mistakes in commands and the app should provide a convenient way to rectify them. - * Highlights: This enhancement affects existing commands and commands to be added in future. It required an in-depth analysis of design alternatives. The implementation too was challenging as it required changes to existing commands. - * Credits: *{mention here if you reused any code/ideas from elsewhere or if a third-party library is heavily used in the feature so that a reader can make a more accurate judgement of how much effort went into the feature}* - -* **New Feature**: Added a history command that allows the user to navigate to previous commands using up/down keys. - -* **Code contributed**: [RepoSense link]() - -* **Project management**: - * Managed releases `v1.3` - `v1.5rc` (3 releases) on GitHub - -* **Enhancements to existing features**: - * Updated the GUI color scheme (Pull requests [\#33](), [\#34]()) - * Wrote additional tests for existing features to increase coverage from 88% to 92% (Pull requests [\#36](), [\#38]()) - -* **Documentation**: - * User Guide: - * Added documentation for the features `delete` and `find` [\#72]() - * Did cosmetic tweaks to existing documentation of features `clear`, `exit`: [\#74]() - * Developer Guide: - * Added implementation details of the `delete` feature. - -* **Community**: - * PRs reviewed (with non-trivial review comments): [\#12](), [\#32](), [\#19](), [\#42]() - * Contributed to forum discussions (examples: [1](), [2](), [3](), [4]()) - * Reported bugs and suggestions for other teams in the class (examples: [1](), [2](), [3]()) - * Some parts of the history feature I added was adopted by several other class mates ([1](), [2]()) - -* **Tools**: - * Integrated a third party library (Natty) to the project ([\#42]()) - * Integrated a new Github plugin (CircleCI) to the team repo - -* _{you can add/remove categories in the list above}_ diff --git a/docs/team/johnnythesnake12.md b/docs/team/johnnythesnake12.md index 48fdebf5671..0a72d7ba5c6 100644 --- a/docs/team/johnnythesnake12.md +++ b/docs/team/johnnythesnake12.md @@ -5,7 +5,11 @@ ### Project: Insurahub -Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers CLI over GUI to use the app. +Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app. +The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients, +assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub. + +While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place. Given below are my contributions to the project. diff --git a/docs/team/luahjunyang.md b/docs/team/luahjunyang.md index 673f107c903..b08a4ea3b6d 100644 --- a/docs/team/luahjunyang.md +++ b/docs/team/luahjunyang.md @@ -5,10 +5,12 @@ ### Project: Insurahub -Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers CLI over GUI to use the app. -The application is mainly used by financial advisors in their day to day planning and scheduling of meetings with clients, +Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app. +The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients, assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub. +While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place. + Given below are my contributions to the project. - **New Feature**: Added the ability to addTags to clients. diff --git a/docs/team/zhanyang01.md b/docs/team/zhanyang01.md index bf69e76b3d3..a9721a90141 100644 --- a/docs/team/zhanyang01.md +++ b/docs/team/zhanyang01.md @@ -7,9 +7,11 @@ ### Project: Insurahub -Insurahub - Insurahub is a desktop app for managing clients, optimized for use via a Command Line Interface (CLI) while still having the benefits of a Graphical User Interface (GUI). If you can type fast, Insurahub can get your contact management tasks done faster than traditional GUI apps. This app is mainly used by insurance agents who have many clients and tasks such as appointments to keep track of on a daily basis. +Insurahub - Insurahub is a CLI application that targets financial advisors that type fast and prefers to use CLI over GUI to use the app. +The application is mainly used by financial advisors in their day-to-day planning and scheduling of meetings with clients, +assisting them by providing quick access to important information of each client stored in the database, displayed on the UI of InsuraHub. -While Insurahub have limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place. +While Insurahub has limited functionalities at this stage, there are further plans to improve the application with the timeline being set in place. Given below are my contributions to the project.