Branch documentation

docs/DeveloperGuide.md

@@ -266,16 +266,22 @@ The following sequence diagram shows how the view operation works:
 
 <puml src="diagrams/ViewSequenceDiagram.puml" alt="ViewSequenceDiagram"></puml>
 
+<box type="info" seamless>
+
 **Note:** The lifeline for `ViewCommand` and `ViewCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
 
+</box>
 User should see the UI as shown below after entering `view 1`  (The command shown in Command Box is re-inputted for the sake of clarity. After entering the command, command should be cleared)
 ![View](images/viewState.png)
 
 Step 3. The user can then read or process the information stored for the viewed person.
 
+<box type="info" seamless>
 
 **Note:** The view command can be most effectively used with `search` and `list`. Since the view index is dependent on the Index on the filtered list shown, the user can view the profile after filtering for specific properties in a person using `search` and sorting them using `list`.
 
+</box>
+
 Alternatives considered
 
 Alternative 1 (Chosen):   
@@ -316,7 +322,7 @@ Finally, the `execute()` method of the `CreateTagCommand` creates a `Tag` object
 
 The following activity diagram summarize what happens when a user attempts to execute the `create` command.
 
-<puml src="diagrams/CreateTagActivityDiagram.puml" />
+<puml src="diagrams/CreateTagActivityDiagram.puml" alt="CreateTagActivityDiagram"/></puml>
 
 ### Search feature
 
@@ -346,8 +352,14 @@ Step 1. The user launches the application.
 Step 2. The user executes `search t/intern` command to filter candidates whose status are offered. 
 
 The following sequence diagram shows how the search operation works:
+<box type="info" seamless>
 
-**Note:** The lifeline for `FindCommand` and `FindCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+**Note:** 
+* The lifeline for `FindCommand` and `FindCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
+* The `parse` method of `FindCommandParsers` also creates objects of the `NameContainsKeywordPredicate`, `StatusContainsKeywordPredicate` and `TagContainsKeywordPredicate` but these
+  were instantiations not included in the sequence diagram below for the sake of brevity. However, do note that the `n`, `s`, `t` arguments in `getPredicatesList(n, s, t)` in the sequence
+  diagram below refer to instances of `NameContainsKeywordPredicate`, `StatusContainstKeywordPredicate` and `TagContainsKeywordPredicate` respectively.
+</box>
 
 <puml src="diagrams/SearchSequenceDiagram.puml" alt="SearchSequenceDiagram" width/>
 
@@ -359,9 +371,11 @@ The following activity diagram shows summarizes what happens when a user attempt
 
 <puml src="diagrams/SearchActivityDiagram.puml" />
 
+<box type="info" seamless>
+
 **Note:** The current implementation of search allows users to search by any of the categories individually or by different combinations of the categories e.g. `search n/alex bernice st/offered t/intern`
 It also allows users to specify more than one search parameter for each category e.g. `search n/alex bernice`
-
+</box>
 ## Delete feature
 
 ### Implementation
@@ -398,8 +412,12 @@ Step 2. The user executes `delete st/interviewed t/developer` command to delete
 
 The following sequence diagram shows how the search operation works:
 
+<box type="info" seamless>
+
 **Note:** The lifeline for `DeleteCommand` and `DeleteCommandParser` should end at the destroy marker (X) but due to a limitation of PlantUML, the lifeline reaches the end of diagram.
 
+</box>
+
 <puml src="diagrams/DeleteSequenceDiagram.puml" alt="DeleteSequenceDiagram" />
 
 Step 3. Assuming Bernice is the applicant matching the requirements, the user should see the UI below upon entering `delete st/interviewed t/developer`.
@@ -410,8 +428,11 @@ The following activity diagram shows summarizes what happens when a user attempt
 
 <puml src="diagrams/DeleteActivityDiagram.puml" />
 
+<box type="info" seamless>
+
 **Note:** The current implementation of delete by tags & status allows users to search by any of the categories individually or by different combinations of the categories.
 It also allows users to specify more than one delete parameter for each category e.g. `delete t/intern manager`
+</box>
 
 ### Set feature
 

docs/UserGuide.md

@@ -734,7 +734,7 @@ An example of the `create` command being successfully executed:
 
 3. View your newly created tags using the `listT` command.
 
-   ![listT-create](images/listT-create.png)
+   ![listT-create](images/listT-create-success.png)
 
 Failed to create tags? Here are some possible reasons why
 

docs/diagrams/CreateTagActivityDiagram.puml

@@ -0,0 +1,19 @@
+@startuml
+'https://plantuml.com/activity-diagram-beta
+|User|
+skin rose
+skinparam ActivityFontSize 15
+skinparam ArrowFontSize 12
+start
+:Start JABPro;
+:User enters create command;
+
+if () then ([Command successfully executed])
+    |JABPro|
+    :Create tag and
+    add to global tag list;
+else ([Command fails to execute])
+    :Show error message;
+endif
+stop
+@enduml

docs/diagrams/DeleteActivityDiagram.puml

@@ -6,12 +6,12 @@ skinparam ActivityFontSize 15
 skinparam ArrowFontSize 12
 start
 :Start JABPro;
-:User enters command;
+:User enters delete command;
 
 if () then ([Command successfully executed])
     |JABPro|
-    :Create tag and
-    add to global tag list;
+    :Display list without
+    the deleted applicant(s);
 else ([Command fails to execute])
     :Show error message;
 endif

docs/diagrams/SearchSequenceDiagram.puml

@@ -2,18 +2,12 @@
 !include style.puml
 skinparam ArrowFontStyle plain
 
-scale 2.0
-
 box Logic LOGIC_COLOR_T1
 participant ":LogicManager" as LogicManager LOGIC_COLOR
 participant ":AddressBookParser" as AddressBookParser LOGIC_COLOR
 participant ":FindCommandParser" as FindCommandParser LOGIC_COLOR
 participant "f:FindCommand" as FindCommand LOGIC_COLOR
 participant ":CommandResult" as CommandResult LOGIC_COLOR
-participant "n:NameContainsKeywordPredicate" as NameContainsKeywordPredicate LOGIC_COLOR
-participant "s:StatusContainsKeywordPredicate" as StatusContainsKeywordPredicate LOGIC_COLOR
-participant "t:TagContainsKeywordPredicate" as TagContainsKeywordPredicate LOGIC_COLOR
-
 end box
 
 box Model MODEL_COLOR_T1
@@ -36,23 +30,6 @@ deactivate FindCommandParser
 AddressBookParser -> FindCommandParser : parse("search st/offered")
 activate FindCommandParser
 
-create NameContainsKeywordPredicate
-FindCommandParser -> NameContainsKeywordPredicate
-activate NameContainsKeywordPredicate
-NameContainsKeywordPredicate --> FindCommandParser : n
-deactivate NameContainsKeywordPredicate
-
-create StatusContainsKeywordPredicate
-FindCommandParser -> StatusContainsKeywordPredicate
-activate StatusContainsKeywordPredicate
-StatusContainsKeywordPredicate --> FindCommandParser : s
-deactivate StatusContainsKeywordPredicate
-
-create TagContainsKeywordPredicate
-FindCommandParser -> TagContainsKeywordPredicate
-activate TagContainsKeywordPredicate
-TagContainsKeywordPredicate --> FindCommandParser : t
-deactivate TagContainsKeywordPredicate
 
 FindCommandParser -> FindCommandParser: getPredicatesList(n, s, t)
 activate FindCommandParser