[CS2113-F14-1] Brokeculator #66
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add Javadoc comments for expense adding, deleting, listing and summarising
Update UG format
V2 miscellaneous
Fix DG bugs
wenenhoe
reviewed
Apr 4, 2024
docs/DeveloperGuide.md
Outdated
| ### Architecture | ||
|
|
||
| The UML diagram below shows the main relationships between the classes in the Brokeculator application. | ||
|  |
There was a problem hiding this comment.
Please use the right symbols to annotate the accessors of the attributes and methods of the class in the diagram.
docs/DeveloperGuide.md
Outdated
|
|
||
| The UML diagram below shows the main relationships between the classes in the category feature. | ||
|  | ||
| </br> |
There was a problem hiding this comment.
Use of line break can be done with \ or <br>. This is currently being rendered in the html version of the DG.
Daviancold
reviewed
Apr 4, 2024
docs/DeveloperGuide.md
Outdated
|  | ||
|
|
||
| ### Category feature | ||
| **Implementation** </br> |
There was a problem hiding this comment.
The </br> tag is not rendered properly. It shows as text in the webpage. Perhaps consider puttting this tag on the next line?
Daviancold
reviewed
Apr 4, 2024
docs/DeveloperGuide.md
Outdated
Comment on lines
40
to
46
| - `addCategory(String category)` - Adds a category to the set of categories | ||
| - `getCategoryListString()` - Returns a string representation of the set of categories | ||
| - `removeCategory(String category)` - Deletes a category from the set of categories | ||
|
|
||
| The `Category` class is supplemented by the following classes to interact with the user: | ||
| - `CategoryCommand` - This class is responsible for handling and executing the commands related to categories | ||
| - `CategoryParser` It is responsible for parsing the user input |
There was a problem hiding this comment.
Formatting inconsistency, there is no dash when describing CategoryParser.
Daviancold
reviewed
Apr 4, 2024
| 2. The `Logic` class directs the user input to the `GeneralInputParser` class, which sees the `summarise` keyword | ||
| in the user input and directs it to the `SummariseParser` class | ||
| 3. The `SummariseParser` class parses the user input and returns a `SummariseCommand` object or an `InvalidCommand` object | ||
| depending on whether the user input is valid or not. A `SummariseCommand` object would store relevant information from |
Daviancold
reviewed
Apr 4, 2024
docs/DeveloperGuide.md
Outdated
Comment on lines
151
to
154
| | v1.0 | student | see a basic summary of my expenses to see how much i have spent in total | ------------------ | | ||
| | v1.0 | student | view the expenses I have logged | know how much I have spent | | ||
| | v1.0 | paranoid user | save my expenses into a file | backup locally via a file to prevent data loss | | ||
| | v1.0 | student | have the ability to add expenses | ------- | |
There was a problem hiding this comment.
Perhaps you could make the user stories more complete by filling in the 'so that I can' part.
Daviancold
reviewed
Apr 4, 2024
docs/DeveloperGuide.md
Outdated
| @@ -1,29 +1,165 @@ | |||
| # Developer Guide | |||
|
|
|||
| * [Acknowledgements](#acknowledgements) | |||
| * [Setting up, getting started] (#setting-up-getting-started) | |||
Change brokeculator error message
Modify logic
Add space to line 111
V2.1 final fixes
Edit PPP Format to fit page limit
Add page breaks to PPP
Modify error handling for adding expense from file
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Brokeculator helps university students manage their expenses