[CS2113-W12-1] QuizHub #8
Conversation
Branch command u gs
Update DG for version 2.0 release
Branch command u gs
…into branch-CommandShuffleTest
Branch command shuffle test
docs/DeveloperGuide.md
Outdated
| 4. `[difficulty]` is the difficulty of the question for sorting later (i.e. Hard) | ||
|
|
||
| *Condensed Class Diagram - Does not contain all attributes & methods | ||
|  |
There was a problem hiding this comment.
Should there be a link between Question and QuestionList?
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Implementation of Edit Command | ||
|
|
||
|  |
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Implementation of Edit Command | ||
|
|
||
|  |
There was a problem hiding this comment.
Could it be possible to omit the class names at the bottom, since it is repeated?
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Class Structure of Start Command | ||
|
|
||
|  |
There was a problem hiding this comment.
Could it be possible to omit the class names as the bottom since it is repeated?
Add assertions for Parser class
Halfway implement MCQ feature
docs/DeveloperGuide.md
Outdated
| `Commands` refer to a package of individual commands with complex and specific | ||
| logic, which is later executed in Quizhub and displayed by `UI`. | ||
|
|
||
| `Storage` is the class through which questions can be stored on the hard drive and `Utility Classes` |
There was a problem hiding this comment.
Would it be better to place the 'Utility Classes' in a new line?
|
|
||
| This starts a loop in which | ||
| user input is continuously read in from CLI for the user command to be extracted and executed. | ||
| In each iteration of the loop, `QuizHub` makes a call to `Ui.getUserInput()` and returns the |
There was a problem hiding this comment.
The diagram says QuizHub calls "readCommand()" but the documentation says "getUserInput()"?
| In each iteration of the loop, `QuizHub` makes a call to `Ui.getUserInput()` and returns the | ||
| entire user input as a String object. Following which, `QuizHub` makes a call to | ||
| `Parser.parseCommand()` to extract the user command from the String object and returns a | ||
| `Command` object. Finally, `QuizHub` makes a call to `Command.executeCommand()` and performs |
There was a problem hiding this comment.
The diagram says QuizHub calls "execute()" but the documentation says "executeCommand()"?
| All commands require a starting payload, but some commands do not require the subsequent arguments. | ||
|
|
||
| ``` | ||
| commandType [payload] [/argument1 [payload1] /argument2 [payload2] ... ] |
There was a problem hiding this comment.
It seems like [ ] is used to indicate both required and optional inputs? Perhaps there is a better way to differentiate them if they are supposed to be different.
docs/DeveloperGuide.md
Outdated
| `find /[description]` OR `find /[module]` | ||
| i.e. `find /water buffalo`, `find /CS2113` |
There was a problem hiding this comment.
Perhaps the examples can be on a new line? It appears to be on the same line in the website. Maybe the format could be standardized for all the different commands.
docs/DeveloperGuide.md
Outdated
| - `/all` will not require any input from `/[start details]` | ||
| 3. The method `getAllQns()` from package `quizhub.questionlist.QuestionList` will be called to retrieve all questions from the storage list. |
There was a problem hiding this comment.
Should '/all' be point 3 and 'getAllQns()' be a subpoint of '/all'? Perhaps 'categoriseListByModules' can also be written as 'categoriseListByModules()' just to standardise.
docs/DeveloperGuide.md
Outdated
| 3. /random will randomize the list of questions using `java.util.Collections.shuffle` and store it within a temporary array to prevent tempering with the original array in Storage | ||
| 4. `/normal` will not requirwritee any further actions, using the previously generated list as specified by `/[quiz mode]` and `/[start details]` |
There was a problem hiding this comment.
Perhaps /random can be written in a code block? I believe there is a typo "requirwritee".
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Class Structure of Start Command | ||
|
|
||
|  |
There was a problem hiding this comment.
Is the exit here same as the exit sequence diagram?
|
|
||
|  | ||
|
|
||
| :exclamation: This sequence diagram emphasizes the process of loading data into storage, and has therefore omitted details of more trivial and/or non-related methods as well as exception handling logic. To find out more about the details, please refer to the complete code and header comments. |
docs/DeveloperGuide.md
Outdated
| 1. For the main structure of the program, we have adapted the project structure | ||
| from the Individual Project of Man Juncheng at [Link](https://github.com/spinoandraptos/ip/tree/master) </li> | ||
| 2. For JUnit testing, we have adapted the testing codes from the AddressBook level-2 | ||
| codes at [Link](https://github.com/se-edu/addressbook-level2)</li> |
There was a problem hiding this comment.
Is </li> supposed to show on the DG?
| are the QuizHub, Ui, Parser and Command packages. | ||
|
|
||
|  | ||
|
|
There was a problem hiding this comment.
I like the addition of an architecture diagram so other developers can easily understand the overall structure of the product
| Lists all the questions in the current QuestionList. | ||
|
|
||
| When executed, the command will invoke the QuestionList.printQuestionList method. | ||
| This method first checks whether the list is empty and prints and error message if empty, | ||
| else it will invoke the QuestionList.printQuestion method on each Question object, | ||
| with the asList parameter set as true. The QuestionList.printQuestion method will then | ||
| print each question with a given index, and indicate the question's type and completion status | ||
| (obtained through Question.getQuestionType() and Question.questionIsDone() methods) |
There was a problem hiding this comment.
I think this can be formatted better, eg. using QuestionList.printQuestionList
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Class Structure of Start Command | ||
|
|
||
|  |
There was a problem hiding this comment.
Should the other "display exit message" be dotted line instead?
docs/DeveloperGuide.md
Outdated
| #### Class Structure of Markdiff Command | ||
|  | ||
|
|
||
|  |
There was a problem hiding this comment.
The arrows here are for inheritance, I think it should be something like "->" instead
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Class structure of Command Exit | ||
|
|
||
|  |
There was a problem hiding this comment.
Should the return arrow be a dotted line?
docs/DeveloperGuide.md
Outdated
|
|
||
| ## Application Lifecycle | ||
|
|
||
|  |
There was a problem hiding this comment.
Is the specific command instance still relevant after the execution? You might consider marking the end of its lifetime with a red X at the bottom of the activation bar.
docs/DeveloperGuide.md
Outdated
|
|
||
| The following sequence diagram shows the implementation of `parseCommand`. | ||
|
|
||
|  |
There was a problem hiding this comment.
I suggest reducing the amount of commands included in the uml diagram as it will improve readability and still convey the same idea.
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Implementation of Edit Command | ||
|
|
||
|  |
There was a problem hiding this comment.
The return arrow for the commandEdit instance should be dotted to comply with the notation covered in the lecture. The same adjustment should me conducted for the lifelines of the different objects.
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Implementation of Edit Command | ||
|
|
||
|  |
There was a problem hiding this comment.
In order to closely follow the convention learned in the lecture, you should delete the "calls" and "returns" statements. It could be visualised by using full vs. dotted lines instead
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Class Structure of Start Command | ||
|
|
||
|  |
There was a problem hiding this comment.
Is your UI calling the parse start command in the implementation? This might either be a wrong representation in your code or it might be a good idea to separate the execution of logic function like parsing from the UI. Use the UI for displaying messages only for very good OOP.
docs/DeveloperGuide.md
Outdated
|
|
||
| #### Class Structure of Start Command | ||
|
|
||
|  |
There was a problem hiding this comment.
The notation of the Ui, CommandStart, ... objects should start with a ":" and optionally an object name. In case of static methods you should add <> above the class name in the diagram
docs/UML/Commands/commandExit.puml
Outdated
| CommandExit -> Ui: Signals the program to exit | ||
| Ui -> Storage: Saves any unsaved data | ||
| Storage --> Ui: Data saved successfully | ||
| Ui -> Ui: Displays exit message |
There was a problem hiding this comment.
You should add an additional activation bar when calling a method inside the same class (see screenshot below):
docs/DeveloperGuide.md
Outdated
| The main execution of the QuizHub application will concern 4 components which | ||
| are the QuizHub, Ui, Parser and Command packages. | ||
|
|
||
|  |
There was a problem hiding this comment.
The architecture diagram is quite clear and concise, nice! The explanation for what each component does is really useful too
docs/DeveloperGuide.md
Outdated
| *Condensed Class Diagram - Does not contain all attributes & methods | ||
|  | ||
|
|
There was a problem hiding this comment.
Perhaps add the multiplicities and relations between the different classes
docs/DeveloperGuide.md
Outdated
|
|
||
| The process of loading data from the storage file specified in the constructor takes places in a few steps. To illustrate the overall flow on loading data, refer to the sequence diagram below. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is it ok for the methods to create the nested activation bar in Storage like this?
docs/DeveloperGuide.md
Outdated
| This command provides users with the ability to randomize the sequence of questions, which can be useful for | ||
| creating randomized quizzes or study sessions. | ||
|
|
||
|  |
There was a problem hiding this comment.
Is it possible to use a UML notation and diagram to represent this instead?
UG Markdiff command format fix
Add MCQ class, command, edit and parse methods
Update user guide to resolve any misinformation and provide clearer instructions
Allow forward slash through escape characters
Fix issues when loading from storage file
Edits to DG uml diagrams size
Edits to DG uml diagrams size for overall flows
Reformat size for Edit Command diagrams
Add Page Breaks to DG
Reformat page breaks in DG
UG, DG Fix
Update UG and bug in parsing edit command
Fix bug in edit command to disallow forward slash
Fix bug in edit command again
Update CommandShuffle when array empty
Update broken link in userguide
update Guan Xiao PPP
Fix dead link JC PPP
QuizHUB is a local desktop app designed to help NUS students easily record examinable questions and generate quizzes from their very own question bank to test their understanding via a Command Line Interface (CLI). Easily launchable on the go, QuizHUB is a versatile tool that aims to streamline and optimize the revision experience for NUS students from all fields of study.