Merge pull request #100 from AY2324S1-CS2103T-T10-2/docs/v1.3-dg

docs: Update v1.3 Developer Guide

docs/diagrams/DeleteTaskSequenceDiagram.puml

@@ -0,0 +1,90 @@
+@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 ":DeleteTaskCommandParser" as DeleteTaskCommandParser LOGIC_COLOR
+participant "c:DeleteTaskCommand" as DeleteTaskCommand LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant "m:ModelManager" as ModelManager MODEL_COLOR
+participant ":AddressBook" as AddressBook MODEL_COLOR
+participant ":UniqueTaskList" as UniqueTaskList MODEL_COLOR
+end box
+
+[-> LogicManager : execute("deleteTask 1")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("deleteTask 1")
+activate AddressBookParser
+
+create DeleteTaskCommandParser
+AddressBookParser -> DeleteTaskCommandParser
+activate DeleteTaskCommandParser
+
+DeleteTaskCommandParser --> AddressBookParser
+deactivate DeleteTaskCommandParser
+
+AddressBookParser -> DeleteTaskCommandParser : parse("1")
+activate DeleteTaskCommandParser
+
+create DeleteTaskCommand
+DeleteTaskCommandParser -> DeleteTaskCommand
+activate DeleteTaskCommand
+
+DeleteTaskCommand --> DeleteTaskCommandParser : c
+deactivate DeleteTaskCommand
+
+DeleteTaskCommandParser --> AddressBookParser : c
+deactivate DeleteTaskCommandParser
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+DeleteTaskCommandParser -[hidden]-> AddressBookParser
+destroy DeleteTaskCommandParser
+
+AddressBookParser --> LogicManager : c
+deactivate AddressBookParser
+
+LogicManager -> DeleteTaskCommand : execute(m)
+activate DeleteTaskCommand
+
+DeleteTaskCommand -> ModelManager : getFilteredTaskList()
+activate ModelManager
+
+ModelManager --> DeleteTaskCommand : lastShownList
+deactivate ModelManager
+
+DeleteTaskCommand -> ModelManager : deleteTask(task)
+activate ModelManager
+
+ModelManager -> AddressBook : deleteTask(task)
+activate AddressBook
+
+AddressBook -> UniqueTaskList : delete(task)
+activate UniqueTaskList
+
+UniqueTaskList --> AddressBook
+deactivate UniqueTaskList
+
+AddressBook --> ModelManager
+deactivate AddressBook
+
+ModelManager --> DeleteTaskCommand
+deactivate ModelManager
+
+create CommandResult
+DeleteTaskCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> DeleteTaskCommand
+deactivate CommandResult
+
+DeleteTaskCommand --> LogicManager : r
+deactivate DeleteTaskCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml

docs/diagrams/EditTaskSequenceDiagram.puml

@@ -0,0 +1,120 @@
+@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 ":EditTaskCommandParser" as EditTaskCommandParser LOGIC_COLOR
+participant "desc:EditTaskDescriptor" as EditTaskDescriptor LOGIC_COLOR
+participant "cmd:EditTaskCommand" as EditTaskCommand LOGIC_COLOR
+participant "res:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("editTask...")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("editTask...")
+activate AddressBookParser
+
+create EditTaskCommandParser
+AddressBookParser -> EditTaskCommandParser : EditTaskCommandParser()
+activate EditTaskCommandParser
+
+EditTaskCommandParser --> AddressBookParser
+deactivate EditTaskCommandParser
+
+AddressBookParser -> EditTaskCommandParser : parse(args)
+activate EditTaskCommandParser
+
+'Constructor for EditTaskDescriptor
+create EditTaskDescriptor
+EditTaskCommandParser -> EditTaskDescriptor : EditTaskDescriptor()
+activate EditTaskDescriptor
+EditTaskDescriptor --> EditTaskCommandParser : desc
+deactivate EditTaskDescriptor
+
+opt has title
+EditTaskCommandParser -> EditTaskDescriptor : setTitle(title)
+activate EditTaskDescriptor
+EditTaskDescriptor --> EditTaskCommandParser
+deactivate EditTaskDescriptor
+end opt
+
+opt has note
+EditTaskCommandParser -> EditTaskDescriptor : setNote(note)
+activate EditTaskDescriptor
+EditTaskDescriptor --> EditTaskCommandParser
+deactivate EditTaskDescriptor
+end opt
+
+opt has tags
+EditTaskCommandParser -> EditTaskDescriptor : setTags(tags)
+activate EditTaskDescriptor
+EditTaskDescriptor --> EditTaskCommandParser
+deactivate EditTaskDescriptor
+end opt
+
+'Constructor for EditTaskCommand
+create EditTaskCommand
+EditTaskCommandParser -> EditTaskCommand : EditTaskCommand(index, desc)
+activate EditTaskCommand
+EditTaskCommand --> EditTaskCommandParser : cmd
+deactivate EditTaskCommand
+
+EditTaskCommandParser --> AddressBookParser : cmd
+deactivate EditTaskCommandParser
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditTaskCommandParser -[hidden]-> AddressBookParser
+destroy EditTaskCommandParser
+
+AddressBookParser --> LogicManager : cmd
+deactivate AddressBookParser
+
+LogicManager -> EditTaskCommand : execute()
+activate EditTaskCommand
+
+EditTaskCommand -> Model : getFilteredTaskList()
+activate Model
+
+Model --> EditTaskCommand : filteredTaskList
+deactivate Model
+
+'Create edited task
+EditTaskCommand -> EditTaskCommand : createEditedTask(taskToEdit, editTaskDescriptor)
+activate EditTaskCommand
+EditTaskCommand --> EditTaskCommand : editedTask
+deactivate EditTaskCommand
+
+EditTaskCommand -> Model : setTask(taskToEdit, editedTask)
+activate Model
+Model --> EditTaskCommand
+deactivate Model
+
+EditTaskCommand -> Model : updateFilteredTaskList(SHOW_ALL_TASKS)
+activate Model
+Model --> EditTaskCommand
+deactivate Model
+
+create CommandResult
+EditTaskCommand -> CommandResult : CommandResult(MESSAGE_EDIT_TASK_SUCCESS)
+activate CommandResult
+
+CommandResult --> EditTaskCommand : res
+deactivate CommandResult
+
+EditTaskCommand --> LogicManager : res
+deactivate EditTaskCommand
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+EditTaskCommand -[hidden]-> LogicManager
+destroy EditTaskCommand
+
+[<--LogicManager
+deactivate LogicManager
+@enduml

docs/diagrams/FindTaskSequenceDiagram.puml

@@ -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 ":FindTaskCommandParser" as FindTaskCommandParser LOGIC_COLOR
+participant "pred:TaskContainsKeywordsPredicate" as TaskContainsKeywordsPredicate LOGIC_COLOR
+participant "cmd:FindTaskCommand" as FindTaskCommand LOGIC_COLOR
+participant "res:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("findTask agenda")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("findTask agenda")
+activate AddressBookParser
+
+create FindTaskCommandParser
+AddressBookParser -> FindTaskCommandParser : FindTaskCommandParser()
+activate FindTaskCommandParser
+
+FindTaskCommandParser --> AddressBookParser
+deactivate FindTaskCommandParser
+
+AddressBookParser -> FindTaskCommandParser : parse("agenda")
+activate FindTaskCommandParser
+
+create TaskContainsKeywordsPredicate
+FindTaskCommandParser -> TaskContainsKeywordsPredicate : TaskContainsKeywordsPredicate(["agenda"])
+activate TaskContainsKeywordsPredicate
+
+TaskContainsKeywordsPredicate --> FindTaskCommandParser : pred
+deactivate TaskContainsKeywordsPredicate
+
+create FindTaskCommand
+FindTaskCommandParser -> FindTaskCommand : FindTaskCommand(pred)
+activate FindTaskCommand
+
+FindTaskCommand --> FindTaskCommandParser : cmd
+deactivate FindTaskCommand
+
+FindTaskCommandParser --> AddressBookParser : cmd
+deactivate FindTaskCommandParser
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+FindTaskCommandParser -[hidden]-> AddressBookParser
+destroy FindTaskCommandParser
+
+AddressBookParser --> LogicManager : cmd
+deactivate AddressBookParser
+
+LogicManager -> FindTaskCommand : execute()
+activate FindTaskCommand
+
+FindTaskCommand -> Model : updateFilteredTaskList(pred)
+activate Model
+
+Model --> FindTaskCommand
+deactivate Model
+
+create CommandResult
+FindTaskCommand -> CommandResult : CommandResult(MESSAGE_TASKS_LISTED_OVERVIEW)
+activate CommandResult
+
+CommandResult --> FindTaskCommand : res
+deactivate CommandResult
+
+FindTaskCommand --> LogicManager : res
+deactivate FindTaskCommand
+
+[<--LogicManager : res
+deactivate LogicManager
+
+'Hidden arrow to position the destroy marker below the end of the activation bar.
+TaskContainsKeywordsPredicate -[hidden]-> LogicManager
+destroy TaskContainsKeywordsPredicate
+destroy FindTaskCommand
+@enduml

docs/diagrams/ListTaskSequenceDiagram.puml

@@ -0,0 +1,55 @@
+@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 "c:ListTaskCommand" as ListTaskCommand LOGIC_COLOR
+participant "r:CommandResult" as CommandResult LOGIC_COLOR
+end box
+
+box Model MODEL_COLOR_T1
+participant ":Model" as Model MODEL_COLOR
+end box
+
+[-> LogicManager : execute("listTask")
+activate LogicManager
+
+LogicManager -> AddressBookParser : parseCommand("listTask")
+activate AddressBookParser
+
+create ListTaskCommand
+AddressBookParser -> ListTaskCommand
+activate ListTaskCommand
+
+ListTaskCommand --> AddressBookParser : c
+deactivate ListTaskCommand
+
+AddressBookParser --> LogicManager : c
+deactivate AddressBookParser
+
+LogicManager -> ListTaskCommand : execute()
+activate ListTaskCommand
+
+ListTaskCommand -> Model : updateFilteredTaskList(PREDICATE_SHOW_ALL_TASKS)
+activate Model
+
+Model --> ListTaskCommand
+deactivate Model
+
+create CommandResult
+ListTaskCommand -> CommandResult
+activate CommandResult
+
+CommandResult --> ListTaskCommand
+deactivate CommandResult
+
+ListTaskCommand --> LogicManager : r
+deactivate ListTaskCommand
+
+[<--LogicManager
+deactivate LogicManager
+
+destroy ListTaskCommand
+@enduml