Add javadoc and update DG #131
Merged
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
NeoMinWei
approved these changes
Oct 31, 2023
| * [User Stories](#user-stories) | ||
| * [Non-Functional Requirements](#non-functional-requirements) | ||
| * [Glossary](#glossary) | ||
| * [Instructions for manual testing](#instructions-for-manual-testing) |
| * | ||
| * @param rawCommand The raw command containing arguments and parameters given by the user. | ||
| * @throws FinancialPlannerException If there is an issue with budget format. | ||
| */ |
There was a problem hiding this comment.
need javadoc for private methods also?
wwweert123
reviewed
Oct 31, 2023
| @@ -2,10 +2,9 @@ | |||
|
|
|||
| participant ":BudgetCommand" as BudgetCommand | |||
| participant "<<class>>\nBudget" as Budget | |||
| participant "<<class>>\nUi" as Ui | |||
| participant ":Ui" as Ui | |||
wwweert123
approved these changes
Oct 31, 2023
| * Returns the current budget. | ||
| * | ||
| * @return The current budget. | ||
| */ |
There was a problem hiding this comment.
I dont think javadocs for getters and setters are necessary :(((
| @@ -10,21 +11,35 @@ | |||
|
|
|||
| import java.time.LocalDate; | |||
|
|
|||
| /** | |||
| * [User Stories](#user-stories) | ||
| * [Non-Functional Requirements](#non-functional-requirements) | ||
| * [Glossary](#glossary) | ||
| * [Instructions for manual testing](#instructions-for-manual-testing) |
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.
Fixes #102