[CS2113T-T09-1] MediTracker #24
Conversation
Added flower command into the help text and corrected a minor spellin…
docs/DeveloperGuide.md
Outdated
|
|
||
| --- | ||
|
|
||
| ### List Medication Command |
There was a problem hiding this comment.
Perhaps you could consider only highlighting the code part instead of the whole sentence.
docs/DeveloperGuide.md
Outdated
| - execute(MedicationManager medicationManager) - Executes the list command and performs its specific task, -t. | ||
| ```Where the task can be either 'list -t all' to list all medications or 'list -t today' to list medications for the day, which is divided into three categories -> Morning, Afternoon and Evening. ``` | ||
|
|
||
| The 'list -t' command requires the following: |
There was a problem hiding this comment.
You could potentially highlight the code part in this segment to make it more readable.
docs/DeveloperGuide.md
Outdated
| The 'search' command requires the following: | ||
| 1. To be added. | ||
|
|
||
| ### Utilising the argument parser |
There was a problem hiding this comment.
Consider using a class diagram to illustrate this to provide visual feedback 😄
docs/DeveloperGuide.md
Outdated
|
|
||
|
|
||
| ## Design & implementation | ||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} |
There was a problem hiding this comment.
Maybe you could remove these documentation instructions as they are not necessary
| ### Export to JSON File | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
You could draw a dotted arrow away from FileReaderWriter to represent the output from "List dailyMedicationList = FileReaderWriter.loadDailyMedicationData();" in your MediTracker class at line 101.
| --- | ||
|
|
||
| ### Export to JSON File | ||
|
|
There was a problem hiding this comment.
Consider adding more design sequence diagrams to describe the functions described in the design and implementation
docs/DeveloperGuide.md
Outdated
|
|
||
|
|
||
| ### Simulated Time | ||
| Talk about the advaned feature. Offset based on the system time so that the user or developer does not have to worry about calculating the time and can just type in the time. |
There was a problem hiding this comment.
Consider fixing the typo "advaned" to "advanced" here.
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Value proposition | ||
|
|
||
| {Describe the value proposition: what problem does it solve?} | ||
| MediTracker ensures that you would now forget your overall schedule on what time and day to take your medication. |
There was a problem hiding this comment.
Shouldn't this be "ensures that you would not forget" instead of "ensures that you would now forget"?
docs/DeveloperGuide.md
Outdated
| The add medication command extends from the Command parent class and implements the following operations: | ||
| - execute(MedicationManager, DailyMedicationManager, Ui) - Adds the medication object into the respective medication managers. | ||
| - setMedicineAttributes() - Sets the medicine object's attributes to be added to the medicine managers. | ||
| - assertionTest(MedicationManager, DailyMedicationManager) - Asserts that medicine has been added to both medication managers. | ||
| - parseStringToValues(Arguments) - Parses string input for medicine quantity and dosage into double type. |
There was a problem hiding this comment.
Perhaps add sequence diagram or class diagram here to show the interactions and relationships since this seems to involve quite a lot of classes?
docs/DeveloperGuide.md
Outdated
| 3. 'today -m' to run printTodayMedications(List<Medication> medications, List<DailyMedication> subList, String period) | ||
| from the DailyMedicationManager | ||
| 4. 'today -a' to run printTodayMedications(List<Medication> medications, List<DailyMedication> subList, String period) | ||
| from the DailyMedicationManager | ||
| 5. 'today -e' to run printTodayMedications(List<Medication> medications, List<DailyMedication> subList, String period) | ||
| from the DailyMedicationManager |
There was a problem hiding this comment.
Perhaps clarify what is the difference between inputting "today -m", "today -a" and "today -e"?
docs/DeveloperGuide.md
Outdated
| |v1.0| user | search medications from existing medicine library | search medications locally to have a quick preview of them and their purpose without the web | | ||
| |v1.0| multipurpose user | Store data locally | Use the application and see the data even when offline between sessions | | ||
| |v1.0| user | know the list of medications I have added | have a quick overview of the medication list and check the quantity and expiry date of each medication | |
There was a problem hiding this comment.
Perhaps clarify what is a "multipurpose user" and how it is different from a normal user?
docs/DeveloperGuide.md
Outdated
| - execute(MedicationManager medicationManager) - Executes the list command and performs its specific task, -t. | ||
| ```Where the task can be either 'list -t all' to list all medications or 'list -t today' to list medications for the day, which is divided into three categories -> Morning, Afternoon and Evening. ``` | ||
|
|
||
| The 'list -t' command requires the following: |
There was a problem hiding this comment.
Perhaps specify that the following parameters need to follow the "list -t" command instead of preceding it or some other order?
docs/DeveloperGuide.md
Outdated
|
|
||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
|
|
There was a problem hiding this comment.
Perhaps add a table of contents at the top of the DG?
docs/DeveloperGuide.md
Outdated
| |v1.0| user | search medications from existing medicine library | search medications locally to have a quick preview of them and their purpose without the web | | ||
| |v1.0| multipurpose user | Store data locally | Use the application and see the data even when offline between sessions | | ||
| |v1.0| user | know the list of medications I have added | have a quick overview of the medication list and check the quantity and expiry date of each medication | | ||
| |v2.0| user | find a to-do item by name | locate a to-do without having to go through the entire list | |
There was a problem hiding this comment.
Perhaps remove this user story since it seems to be a remnant from the project template that does not seem to be relevant to this application?
| tests have been added to ensure that certain attributes of the `Argument` classes do not clash with | ||
| one another. `HelpArgument` is automatically added when an `ArgumentList` object is instantiated. | ||
| Calling `ArgumentList.parse` with empty `String` or invoking with the argument `-h` will trigger the | ||
| help message to be printed on the console. |
There was a problem hiding this comment.
Consider explaining how "trigger" works.
| the key. In order to query the returned data structure, you can utilise the same enum. | ||
|
|
||
| In order to utilise the argument parser, | ||
| 1. Determine if the `Argument` variant already exist. If not, create a new class and extend the `Argument` class. |
fix: Handle NoSuchElementException when Ctrl-C termination
docs: Add content to DG
docs: Update DG and PPP
# Conflicts: # docs/DeveloperGuide.md
Update developer guide for page breaks and user stories ordering
Updates PPP
docs: Update search DG
Eric update developer guide
MediTracker is a Command Line Interface (CLI) app to track your medications. It gives you the capability to manage your medications taken on a daily basis such as indicating if you have taken your medication and when it is going to expire.