Skip to content

Commit

Permalink
Merge pull request #208 from Rishit02/update-dg
Browse files Browse the repository at this point in the history
Update DG
  • Loading branch information
pjanthony2001 authored Apr 15, 2024
2 parents bb807d5 + 6165946 commit b40e9b7
Show file tree
Hide file tree
Showing 4 changed files with 57 additions and 21 deletions.
36 changes: 36 additions & 0 deletions docs/DeveloperGuide.md
Original file line number Diff line number Diff line change
Expand Up @@ -428,6 +428,40 @@ Priorities: High (must have) - `* * *`, Medium (nice to have) - `* *`, Low (unli

Use case ends.

**Use case: Schedule an event**

**MSS**

1. User requests to schedule an event
2. ConnectCare schedules the event

Use case ends.

**Extensions**

* 1a. The details of the event are incorrect

* 1a1. ConnectCare shows an error message.

Use case ends.

**Use case: Delete an event**

**MSS**

1. User requests to delete an event
2. ConnectCare deletes the event

Use case ends.

**Extensions**

* 1a. The details of the event are incorrect

* 1a1. ConnectCare shows an error message.

Use case ends.

**Use case: Exit the application**

**MSS**
Expand Down Expand Up @@ -509,6 +543,8 @@ testers are expected to do more *exploratory* testing.

### Planned Enhancements

Team size: 5

1. Currently, names must be unique and must only contain alphanumeric characters. This means different languages and special characters are not allowed, and we are planning to include these in the future.

2. There is currently no method for new user to clear or find schedules quickly. We are planning to add these commands and expand the capability of this feature in the future.
Expand Down
20 changes: 10 additions & 10 deletions docs/diagrams/DeleteSequenceDiagram.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":CommandParser" as CommandParser LOGIC_COLOR
participant ":DeleteCommandParser" as DeleteCommandParser LOGIC_COLOR
participant "d:DeleteCommand" as DeleteCommand LOGIC_COLOR
participant "result:CommandResult" as CommandResult LOGIC_COLOR
Expand All @@ -17,17 +17,17 @@ end box
[-> LogicManager : execute("delete 1")
activate LogicManager

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

create DeleteCommandParser
AddressBookParser -> DeleteCommandParser
CommandParser -> DeleteCommandParser
activate DeleteCommandParser

DeleteCommandParser --> AddressBookParser
DeleteCommandParser --> CommandParser
deactivate DeleteCommandParser

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

create DeleteCommand
Expand All @@ -37,14 +37,14 @@ activate DeleteCommand
DeleteCommand --> DeleteCommandParser : d
deactivate DeleteCommand

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

AddressBookParser --> LogicManager : d
deactivate AddressBookParser
CommandParser --> LogicManager : d
deactivate CommandParser

LogicManager -> DeleteCommand : execute(m)
activate DeleteCommand
Expand Down
8 changes: 4 additions & 4 deletions docs/diagrams/ParserClasses.puml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Class XYZCommand

package "Parser classes"{
Class "<<interface>>\nParser" as Parser
Class AddressBookParser
Class CommandParser
Class XYZCommandParser
Class CliSyntax
Class ParserUtil
Expand All @@ -19,12 +19,12 @@ Class Prefix
}

Class HiddenOutside #FFFFFF
HiddenOutside ..> AddressBookParser
HiddenOutside ..> CommandParser

AddressBookParser .down.> XYZCommandParser: <<create>>
CommandParser .down.> XYZCommandParser: <<create>>

XYZCommandParser ..> XYZCommand : <<create>>
AddressBookParser ..> Command : <<use>>
CommandParser ..> Command : <<use>>
XYZCommandParser .up.|> Parser
XYZCommandParser ..> ArgumentMultimap
XYZCommandParser ..> ArgumentTokenizer
Expand Down
14 changes: 7 additions & 7 deletions docs/diagrams/UndoSequenceDiagram-Logic.puml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ skinparam ArrowFontStyle plain

box Logic LOGIC_COLOR_T1
participant ":LogicManager" as LogicManager LOGIC_COLOR
participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
participant ":CommandParser" as CommandParser LOGIC_COLOR
participant "u:UndoCommand" as UndoCommand LOGIC_COLOR
end box

Expand All @@ -14,18 +14,18 @@ end box
[-> LogicManager : execute(undo)
activate LogicManager

LogicManager -> AddressBookParser : parseCommand(undo)
activate AddressBookParser
LogicManager -> CommandParser : parseCommand(undo)
activate CommandParser

create UndoCommand
AddressBookParser -> UndoCommand
CommandParser -> UndoCommand
activate UndoCommand

UndoCommand --> AddressBookParser
UndoCommand --> CommandParser
deactivate UndoCommand

AddressBookParser --> LogicManager : u
deactivate AddressBookParser
CommandParser --> LogicManager : u
deactivate CommandParser

LogicManager -> UndoCommand : execute()
activate UndoCommand
Expand Down

0 comments on commit b40e9b7

Please sign in to comment.