[CS2113-T12-3] Student Exchange Programme Helper #22
Conversation
| Sequence Diagram of Storage initialisation: | ||
|
|
||
|  | ||
|
|
| # Architecture | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Architecture is clear and easy to understand.
| The following sequence diagram shows the relationship between the classes involved when the delete command is called. | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
Activation bar of :HelpCommandModule appears to be cut off from the top and bottom
docs/DeveloperGuide.md
Outdated
| 2. Parser : Processes and Executes User Commands | ||
| 3. UI : Prints out messages to user | ||
| 4. Storage : Processes and stores | ||
| 5. DataReader |
There was a problem hiding this comment.
Is there a missing whitespace here? (Diagram says "Data Reader")
|
|
||
| The following class diagrams illustrates the relationship between the Parser class and the Command classes. | ||
| - (TODO: finish up the rest of the command cases) | ||
|  |
There was a problem hiding this comment.
-
The UML Diagram is very large, and many of the command classes are still incomplete. Maybe try to break it up into different diagrams or use reference frames
-
There is also a case of 4-level self-invocation. Maybe can also make use of reference frames for this?
docs/DeveloperGuide.md
Outdated
|
|
||
| The following sequence diagram shows the relationship between the classes involved when the delete command is called. | ||
|
|
||
|  |
There was a problem hiding this comment.
For return values, I think it is sufficient to write "true" instead of "return true", as it should already be clear it is a return value by the dotted arrow.
docs/DeveloperGuide.md
Outdated
|
|
||
| Sequence Diagram of List Current Command. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is there a reason why the dotted arrow at the end of ui:UI goes leftwards instead of right like other arrows?
docs/DeveloperGuide.md
Outdated
| ## Acknowledgements | ||
|
|
||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well} | ||
| {list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the |
docs/DeveloperGuide.md
Outdated
|
|
||
| DataReader class reads two external .txt files to acquire the list of Partner Universities and list | ||
| of Modules available in the PUs, and provides this information to other components. | ||
|
|
||
| {Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.} |
| Sequence Diagram of Storage initialisation: | ||
|
|
||
|  | ||
|
|
docs/DeveloperGuide.md
Outdated
|
|
||
| Sequence Diagram of List Current Command. | ||
|
|
||
|  |
docs/DeveloperGuide.md
Outdated
| > Syntax: list current [_uniAbbreviation_] | ||
|
|
||
| Sequence Diagram of List Current Pu Command | ||
|  |
docs/DeveloperGuide.md
Outdated
|
|
||
| The following sequence diagram shows the relationship between the classes involved when the delete command is called. | ||
|
|
||
|  |
There was a problem hiding this comment.
activation bar should end when the method ends
docs/DeveloperGuide.md
Outdated
| The help command provides a list of commands and the commands' respective input format for the user. | ||
| > Syntax: /help | ||
|
|
||
| The following sequence diagram shows the relationship between the classes involved when the delete command is called. |
There was a problem hiding this comment.
There is a typo here regarding the delete command
docs/DeveloperGuide.md
Outdated
|
|
||
| The following sequence diagram shows the relationship between the classes involved when the delete command is called. | ||
|
|
||
|  |
There was a problem hiding this comment.
The method call printHelpCommandMessage() from :HelpModuleCommand should be at the start of the activation bar.
docs/DeveloperGuide.md
Outdated
| **Note: Partner Universities Abbreviations can be found using List Pu command** | ||
|
|
||
| Sequence Diagram of List Pu Modules Command. | ||
|  |
There was a problem hiding this comment.
Nice diagram! But the final return from the static UI class should be at the end of the activation bar
docs/DeveloperGuide.md
Outdated
|
|
||
| Sequence Diagram of List Current Command. | ||
|
|
||
|  |
There was a problem hiding this comment.
Nice! It would be better if the self-invoked method had an return arrow on the same side of the activation bar going back into the bar.
docs/DeveloperGuide.md
Outdated
|
|
||
| Sequence Diagram of Storage initialisation: | ||
|
|
||
|  |
There was a problem hiding this comment.
It would be better to add figure numbers to your diagrams too!
docs/DeveloperGuide.md
Outdated
| Sequence Diagram of Storage initialisation: | ||
|
|
||
|  |
There was a problem hiding this comment.
Sequence diagram looks blur, but it seems like the return values are not indicated with a dotted line.
docs/DeveloperGuide.md
Outdated
| The commands that the parser class will initialise are ListPuCommand(), ListCurrentCommand(modules), | ||
| prepareListPuModulesCommand(userCommandSecondKeyword, universities), ExitCommand(), | ||
| prepareAddModuleCommand(storage, userCommandSecondKeyword, puModules, universities), | ||
| DeleteModuleCommand(storage, indexToRemove, modules), and HelpCommand(). The parser class will handle error checking by |
There was a problem hiding this comment.
Perhaps you can consider reformatting this to make it easier to read, as all the commands are lumped together and messy.
|
|
||
| The following class diagrams illustrates the relationship between the Parser class and the Command classes. | ||
| - (TODO: finish up the rest of the command cases) | ||
|  |
There was a problem hiding this comment.
The third alt case does not state the condition explicitly, which makes it unclear on when this is called.
docs/DeveloperGuide.md
Outdated
|
|
||
| ### Add Module Command | ||
|
|
||
| Adds the Module the user has wants to save to the saved modules database. |
There was a problem hiding this comment.
Is this line correct? I am still able to understand but seems like there is some typo.
docs/DeveloperGuide.md
Outdated
| > Syntax: list current [_uniAbbreviation_] | ||
|
|
||
| Sequence Diagram of List Current Pu Command | ||
|  |
There was a problem hiding this comment.
Another small typo in the image "UserConcole"
docs/DeveloperGuide.md
Outdated
| **Note: Partner Universities Abbreviations can be found using List Pu command** | ||
|
|
||
| Sequence Diagram of List Pu Modules Command. | ||
|  |
There was a problem hiding this comment.
I feel like your UML diagram is a bit big and filled with a lot of words. Maybe you could try to make it more concise by making it small and precise.
…into Branch-DeadlineStorage-Singleton # Conflicts: # src/main/java/seedu/duke/Duke.java # src/test/java/seedu/duke/ParserTest.java # src/test/java/seedu/duke/command/DeleteModuleCommandTest.java # src/test/java/seedu/duke/command/ExitCommandTest.java # src/test/java/seedu/duke/command/HelpCommandTest.java # src/test/java/seedu/duke/command/InvalidCommandTest.java
Change DeadlineStorage classs into singleton pattern
…into branch-Parser-Singleton # Conflicts: # src/test/java/seedu/duke/command/DeleteModuleCommandTest.java # src/test/java/seedu/duke/command/ExitCommandTest.java # src/test/java/seedu/duke/command/HelpCommandTest.java # src/test/java/seedu/duke/command/InvalidCommandTest.java
Change Parser class into singleton pattern
Update DG Deadline and Budget test details
Fix bugs in DG
Update parser sequence diagrams
Update PPP
Update AboutUs
Update Developer Guide Budget Commands
Format budget DG
Change UG DG QUICK START
Preparing NUS Mech Eng students to embark on a SEP, as journeying into a foreign country is overwhelming. Our solution will be a quick way to let them know which modules can be mapped to their desired university and the better flight and accommodation options that are within their budget.