Merge remote-tracking branch 'upstream/master'

docs/DeveloperGuide.md

@@ -8,13 +8,21 @@
     - [Legend](#legend)
 - [Quick Start](#quick-start-)
 - [Design & Implementation](#design--implementation-)
+    - [System Architecture](#system-architecture)
+    - [Main Component](#main-component)
+    - [UI Package](#ui-package)
+    - [Parser Package](#parser-package)
+    - [Command Package](#command-package)
+    - [EntryList Package](#entrylist-package)
+    - [Entry Package](#entry-package)
+    - [Storage Package](#storage-package)
 - [Product Scope](#product-scope-)
     - [Target User Profile](#target-user-profile)
     - [Value Proposition](#value-proposition)
 - [User Stories](#user-stories-)
 - [Non-Functional Requirements](#non-functional-requirements-)
 - [Manual Testing](#manual-testing-)
-- [Command Summary](#command-summary-)
+- [Command Summary](#command-summary-%EF%B8%8F)
 - [Glossary](#glossary-)
 - [Acknowledgements](#acknowledgements-)
 
@@ -46,7 +54,7 @@ Head to the [FAQ](https://ay2324s1-cs2113t-w11-2.github.io/tp/UserGuide.html#faq
 - Do you have a bug to report?   
 Head to the [Bug Reporting](https://ay2324s1-cs2113t-w11-2.github.io/tp/UserGuide.html#bug-reporting-) page in the User Guide.   
 - Do you want a concise summary of all functionalities?   
-Head to the [Command Summary](#command-summary-) page for a summary of all commands.   
+Head to the [Command Summary](#command-summary-%EF%B8%8F) page for a summary of all commands.   
 - Not sure what that word meant?    
 Head to the [Glossary](#glossary-) page for its meaning.
 
@@ -131,12 +139,12 @@ Actual detailed implementation may differ from the architectural diagram.
 
 WildWatch is comprised of 7 major components.  
 - `Main`: Entry point of the program.
-- `UI`: A class that receives input from, and prints output to the user.
-- `Parser`: A class that processes and interprets the input command of the user.
-- `Command`: A set of classes that does specific task according to the command of the user.
-- `EntryList`: A class that stores all the wildlife data, while the program is running.
-- `Entry`: A class that stores individual wildlife data, while the program is running.
-- `Storage`: A class that saves and retrieves all the wildlife data from the local storage
+- `UI`: A package that receives input from, and prints output to the user.
+- `Parser`: A package that processes and interprets the input command of the user.
+- `Command`: A package that does specific task according to the command of the user.
+- `EntryList`: A package that stores all the wildlife data, while the program is running.
+- `Entry`: A package that stores individual wildlife data, while the program is running.
+- `Storage`: A package that saves and retrieves all the wildlife data from the local storage
 
 [⬆ Back to top](#table-of-contents)  
 
@@ -179,7 +187,9 @@ The **_Parser Class Diagram_** below shows how `Execute`, `Parser`, `Error`, `Co
 
 ### Command Package  
 The `Command` components can be found within the `Command` package.  
+
 ![Command Sequence Diagram](images/AddSequenceDiagram.png)  
+The above sequence diagram depicts how WildWatch executes an `add` command.  
 
 ### EntryList Package  
 The `EntryList` class can be found within the `Entry` package.  
@@ -196,9 +206,19 @@ Each `Entry` object holds the data of a single animal entry, residing in the sta
 
 ![image](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/ee46913d-dfc5-4fd5-85ef-53bb03546085)    
 The class diagram above shows the relationship beteen the `Entry`, `EntryList`, and `ArrayList` classes.  
+
+[⬆ Back to top](#table-of-contents)  
+<div style="page-break-after: always;"></div>
 
 ### Storage Package   
 The `Storage` components can be found within the `Storage` package.   
+The components work together to read from previously saved file in the local memory.  
+The entry data is then loaded into the program.  
+If a valid command that changes the entry data is executed, the relevant changes are saved onto the local file.  
+
+![image](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/e40d9399-a56e-4d4f-953a-024e1252054f)  
+The class diagram above shows the relationship between the different classes in the `Storage` package.
+
 
 [⬆ Back to top](#table-of-contents)   
 
@@ -309,7 +329,7 @@ Expected: You will be prompted with further questions.
 
 ### 9. Exiting the app
 1. Run the `bye` command.  
-Expected: The app stops.     
+Expected: WildWatch program terminates.       
 
 [⬆ Back to top](#table-of-contents)   
 

docs/UserGuide.md

@@ -114,7 +114,7 @@ Example:
 
 ![image](https://github.com/AY2324S1-CS2113T-W11-2/tp/assets/69474977/d548f580-3098-4d9d-8635-07e0a989e47c)  
 
-[⬆ Back to top](#table-of-contents)
+<div style="page-break-after: always;"></div>  
 
 #### 1.2 Interactive Mode: `add i/`
 Did you forget the fields to in the `add` command? Fear not, we've got your back!   

docs/team/woodenclock.md

@@ -31,15 +31,17 @@ To view the codes that I have contributed to the team project WildWatch, click [
 
 ### Enhancements Implemented  
 1. Organizing all class files into their repective packages (e.g., `ui`, `execute`, etc).  
-2. Created `List`, `Find`, `Bye` classes in `Command Package`.  
-3. Created the `Entry` and `EntryList` classes in `Entry Package`.  
-4. Created `DateChecker` and `ErrorHandler` (skeleton was enhanced by [Cai Ting](https://ay2324s1-cs2113t-w11-2.github.io/tp/team/lctxct.html)) classes in Error Package.  
-5. Created `InputHandler` and `CommandHandler` classes in Execute Package.  
-6. Created `BootUp`, `ShutDown`, and `LogHandler` classes in Miscellaneous Package.  
-7. Created `EditCommandParser` and `FindCommandParser` classes in Miscellaneous Package.  
-8. Created `ExistenceChecker`, `FileCreater`, `FileHandler`, `FileLoader`, `Saver`, and `EntryToStingConverter` (half) classes in Storage Package.  
-9. Created `EmptyDescriptionPrinter`, `EntryPrinter`, `ErrorPrinter`, `FilePrinter`, `InputConsole`, `LinePrinter`, `ListCommandPrinter`, `SearchResultPrinter` classes in Ui Package.
-10. Updated README.md page from Duke to WildWatch appropriately.  
+2. Created `List`, `Find`, and `Bye` classes in `Command Package`.
+3. Enhanced `Export`, `Summary`, `Help` classes in `Command Package` to be more robust and user-friendly.  
+4. Created the `Entry` and `EntryList` classes in `Entry Package`.  
+5. Created `DateChecker` and `ErrorHandler` (skeleton was enhanced by [Cai Ting](https://ay2324s1-cs2113t-w11-2.github.io/tp/team/lctxct.html)) classes in Error Package.  
+6. Created `InputHandler` and `CommandHandler` classes in `Execute Package`.  
+7. Created `BootUp`, `ShutDown`, and `LogHandler` classes in `Miscellaneous Package`.  
+8. Created `EditCommandParser`, `ListCommandParser` and `FindCommandParser` classes in `Parser Package`.
+9. Enhanced `SummaryCommandParser` class in `Parser Package` to be case-insensitive.  
+10. Created `ExistenceChecker`, `FileCreater`, `FileHandler`, `FileLoader`, `Saver`, and `EntryToStingConverter` (half) classes in `Storage Package`.  
+11. Created `EmptyDescriptionPrinter`, `EntryPrinter`, `ErrorPrinter`, `FilePrinter`, `InputConsole`, `LinePrinter`, `ListCommandPrinter`, `SearchResultPrinter` classes in `Ui Package`.
+12. Updated README.md page from Duke to WildWatch appropriately.  
 
 [⬆ Back to top](#table-of-contents)  
 
@@ -57,7 +59,7 @@ To view the codes that I have contributed to the team project WildWatch, click [
 1. Created `Table of Contents` Section, ensured all links are working.  
 2. Created `Intoduction` Section, which includes Welcome Message, Description, Purpose, Audience, and Legend.  
 3. Created `Quick Start` Section, which guides new comers on how to get WildWatch up and running.  
-4. Created `System Architecture`, `Architecture Diagram`, `General Sequence Diagram` Sub-Sections and their respective descriptions.  
+4. Created `Design & Implementation` Section and their respective descriptions (did everything except Command Sequence Diagram).  
 5. Created `Product Scope` Section, which described the `Target User Profile` and `Value Proposition`.
 6. Created `Glossary` and `Acknowledgement` Sections.