[CS2113T-F11-2] CEGMods#51
Conversation
updated test cases
Improve code quality
Add Ui, printWelcomeMessage, and printHelpMessage
add ui,welcome,help
add ProjectTask and ProjectManager
edit task class,tasklist,timetable and add storage
edit javadoc
add api, change module, timetable need change
| ## 3. Design | ||
| ### 3.1 Architecture | ||
| The ***Architecture diagram*** given below shows the major components, and explains the structure of the software system. | ||
| [](https://freeimage.host/i/3Ei2Vf) |
There was a problem hiding this comment.
Perhaps there should be a Command class handling the operations like print, add and delete, instead handled by Parser class?
| The user type in command in `module mod/<MODULE_CODE> lec/<LECTURE_DAY> <LECTURE_TIME> tut/<TUTORIAL_DAY> <TUTORIAL_TIME> lab/<LAB_DAY> <LAB_TIME>` this form to add a module into the timetable. The time slot of lab is optional. The program will detect whether the user command is in this form, and store module data in arraylist `modules` in `Timetable` class after Ui passing command and calling `addModule()` in Parser class. | ||
|
|
||
| The ***sequence diagram*** below shows the interaction between these classes when the user adds a module. | ||
| [](https://freeimage.host/i/3GRaM7) |
There was a problem hiding this comment.
Consider reaplacing the input from user to ui with the actual input, instead of "add a module".
| ## 3. Design | ||
| ### 3.1 Architecture | ||
| The ***Architecture diagram*** given below shows the major components, and explains the structure of the software system. | ||
| [](https://freeimage.host/i/3Ei2Vf) |
There was a problem hiding this comment.
Storage class is missing from the architecture diagram, or the app data not stored?
| ## 3. Design | ||
| ### 3.1 Architecture | ||
| The ***Architecture diagram*** given below shows the major components, and explains the structure of the software system. | ||
| [](https://freeimage.host/i/3Ei2Vf) |
There was a problem hiding this comment.
Perhaps could combine Timetable, Module and Task into a data model component?
| {Describe the value proposition: what problem does it solve?} | ||
| ## 2. Setting up and getting started | ||
| Setting up the project in your computer | ||
| > <font color=#FF5733>Caution: </font> <font color=#00000><font color=#00000> **Please follow each steps in the guide carefully.** </font> |
There was a problem hiding this comment.
Caution and Note are not displaying properly.
| The `Timetable` class shows the timetable for all the module slots and tasks. It also stores `Module` details in an arraylist and checks whether there is a time conflict between two classes. | ||
|
|
||
|
|
||
| ## 4. Implementation |
There was a problem hiding this comment.
Can add a few more UML diagram for Design and Implementation.
QX-CHEN
left a comment
There was a problem hiding this comment.
Generally, more details can be added to design and implementation.
Edit spacing for PPP
update help feature
update PPP
…into UG_2101Formatting * 'master' of https://github.com/AY2021S1-CS2113T-F11-2/tp: (23 commits) Update AboutUs.md Update AboutUs.md Update AboutUs.md update PPP Add files via upload Create image update help feature Update AboutUs.md Update AboutUs.md add author Update DeveloperGuide.md rename PPP update DG add protfolio Rename docs/zhangcaicai123.md to docs/team/zhangcaicai123.md Update zhangcaicai123.md add zhang danrui's PPP update DG, fix superlinks fix project task bug update readme file ... # Conflicts: # docs/DeveloperGuide.md # docs/UserGuide.md
Ug 2101 formatting
CEGMods is a time scheduler app that manage different issues and tasks which is optimized for CEG students. It is optimized for CLI users so that frequent tasks can be done faster by typing in commands