[CS2113-T18-1] Movie Reviews#47
Conversation
|
@naz019 Closing this PR because this PR does not seem to comply with our requirements. Possible reasons:
|
| @@ -2,7 +2,7 @@ | |||
|
|
|||
| ## Acknowledgements | |||
There was a problem hiding this comment.
In the Ui UML Diagram, the accessibility of the attributes and methods are represented by different symbols (such as diamonds, square etc). Maybe you might want to disable the skinparam to display as '+' and '-' as how we usually do those?
|
|
||
| ## Acknowledgements | ||
|
|
||
| {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.
Media class is shown as abstract in the UML diagram. However, it is not implemented as an abstract class. Is it supposed to be just shown as 'normal' class in the UML diagram?
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
| AddressBook-Level3 https://github.com/se-edu/addressbook-level3 | ||
|
|
||
| ## Design & implementation |
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
| AddressBook-Level3 https://github.com/se-edu/addressbook-level3 | ||
|
|
||
| ## Design & implementation |
Added addCommand and findCommand sequence diagrams.
Added diagrams to developer guide
updated Developer Guide
Updated Developer's Guide
adding List/Sort Descriptions
Added testing for Parser
hughjazzman
left a comment
hughjazzman
left a comment
There was a problem hiding this comment.
Some comments! Some bugs are repeated, so make sure to fix them for all diagrams.
| * Output various messages to the user | ||
|
|
||
| ## Design & implementation | ||
|  |
There was a problem hiding this comment.
Note that this is non-standard UML notation. You can use the info here to change settings for PlantUML: nus-cs2113-AY2122S1/forum#114
| The command component enables users to make changes to their review list. The command word is taken from the first word | ||
| of the user input, and is processed through the `Parser` class. The class diagram shows how the Commands parent class is | ||
| implemented, as well as its extended classes. | ||
|  |
There was a problem hiding this comment.
Might this italicised String execute be a bug?
| DukeException error is thrown. | ||
| 4. A new variable of type Media parent class, `toAdd`, is then created. The `AddCommand` function is then called to add | ||
| the Movie or Tv Show `toAdd` into the review list, `reviewList`. | ||
|  |
There was a problem hiding this comment.
Consider adding : to signify these as instance of their classes.
| 4. A new variable of type Media parent class, `toAdd`, is then created. The `AddCommand` function is then called to add | ||
| the Movie or Tv Show `toAdd` into the review list, `reviewList`. | ||
|  | ||
|
|
There was a problem hiding this comment.
Consider breaking up the diagram. If showing the sequence of AddComand, you can concentrate on the sequence that is unique to AddCommand. Reference frames could be useful.
| 4. A new variable of type Media parent class, `toAdd`, is then created. The `AddCommand` function is then called to add | ||
| the Movie or Tv Show `toAdd` into the review list, `reviewList`. | ||
|  | ||
|
|
There was a problem hiding this comment.
There may be missing/extra lifelines here.
| 2. The `Parser` object calls on `executeList` which is responsible for creating a `ListCommand` Object. It then calls on its `execute` method to execute the proper actions. | ||
| 3. In this `execute` function, it loops through all the stored reviews and separates each review based on category and formats using the proper `toString` method. | ||
| 4. Finally, an output string is returned and the `Parser` class calls on the `UI` object to print the output to the user. | ||
|  |
There was a problem hiding this comment.
This could be a bug, is this a self-invocation?
| 2. The `Parser` object calls on `executeList` which is responsible for creating a `ListCommand` Object. It then calls on its `execute` method to execute the proper actions. | ||
| 3. In this `execute` function, it loops through all the stored reviews and separates each review based on category and formats using the proper `toString` method. | ||
| 4. Finally, an output string is returned and the `Parser` class calls on the `UI` object to print the output to the user. | ||
|  |
There was a problem hiding this comment.
This return might need to be dotted?
Edited User Guide
updated PPP
shortened PPP
updated PPP links
Added more javadoc
adding prof picture
updated favourites command
updated UG with latest output
updated sort
Fixed minor DG error
8 participants
No description provided.