Skip to content

Commit

Permalink
fixed UG
Browse files Browse the repository at this point in the history
  • Loading branch information
gaoqikai committed Oct 31, 2018
1 parent cfddcda commit 5c00f00
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 90 deletions.
158 changes: 96 additions & 62 deletions docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -111,9 +111,24 @@ Examples:
Decreases the quantity of the 1st item by 20

=== Listing all items : `list`

Shows all items in the stock list +
Format: `list`

=== Selecting and highlighting an item : `select`

Selects and highlights one item using its index number +
Format: `select INDEX`

Examples:

* `select 1` +
Selects and highlights the item with the index number 1

=== Clearing all items : `clear`

Clears all items in the stock list +
Format: `clear`

=== Locating items by name: `find`

Expand Down Expand Up @@ -160,10 +175,12 @@ Examples:
This would update the status of the 20 arduinos to On_Loan, and add the entry into the loan list

=== Viewing the loan list: `viewLoanList`

Shows every loan list entry +
Format: `viewLoanList`

=== Deleting a loan list entry: `deleteLoanList`

An entry in the loan list can be deleted when the loaner returns the items +
Format: `deleteLoanList INDEX`

Expand Down Expand Up @@ -202,43 +219,6 @@ Examples:
* `deleteTag 1 t/ Lab1 t/ Lab2` +
Deletes tags "Lab1" and "Lab2" from the item with index 1

=== Listing entered commands : `history`

Lists all the commands that you have entered in reverse chronological order. +
Format: `history`

[NOTE]
====
Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and next input respectively in the command box.
====

// tag::undoredo[]
=== Undoing previous command : `undo`

Restores the address book to the state before the previous _undoable_ command was executed. +
Format: `undo`

[NOTE]
====
Undoable commands: those commands that modify the address book's content (`add`, `delete`, `edit` and `clear`).
====

Examples:

* `delete 1` +
`list` +
`undo` (reverses the `delete 1` command) +

* `select 1` +
`list` +
`undo` +
The `undo` command fails as there are no undoable commands executed previously.

* `delete 1` +
`clear` +
`undo` (reverses the `clear` command) +
`undo` (reverses the `delete 1` command) +

=== Lost an item: `lost`

Lost an item From the stock list +
Expand Down Expand Up @@ -266,7 +246,31 @@ Examples:
Shows the number of every lost item that has been lost +
Format: `lost&found`

=== Undoing previous command : `undo`

Restores the address book to the state before the previous _undoable_ command was executed. +
Format: `undo`

[NOTE]
====
Undoable commands: those commands that modify the address book's content (`add`, `delete`, `edit` and `clear`).
====

Examples:

* `delete 1` +
`list` +
`undo` (reverses the `delete 1` command) +

* `select 1` +
`list` +
`undo` +
The `undo` command fails as there are no undoable commands executed previously.

* `delete 1` +
`clear` +
`undo` (reverses the `clear` command) +
`undo` (reverses the `delete 1` command)

=== Redoing the previously undone command : `redo`

Expand All @@ -289,10 +293,21 @@ The `redo` command fails as there are no `undo` commands executed previously.
`undo` (reverses the `delete 1` command) +
`redo` (reapplies the `delete 1` command) +
`redo` (reapplies the `clear` command) +
// end::undoredo[]

// tag::savecommand[]

=== Listing entered commands : `history`

Lists all the commands that you have entered in reverse chronological order. +
Format: `history`

[NOTE]
====
Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and next input respectively in the command box.
====

=== Save current version of stock list : `save`

An xml file recording current stocks will be created and named. +
Format: `save NAME`

Expand All @@ -303,6 +318,17 @@ This would save the stock list at the time when the command is inputted, and the
`ForAugust.xml`, under a /versions/ folder in main.
// end::savecommand[]

=== Open a saved stock list : `open`

An xml file recording current stocks will be opened. +
Format: `open NAME`

Examples:

* `open ForAugust` +
This would open the saved stock list under /versions/ folder in main at the time when the command is inputted


=== Exiting the program : `exit`

Exits the program. +
Expand All @@ -326,37 +352,45 @@ _{explain how the user can enable/disable data encryption}_

== Command Summary

* *Help* `help`
* *Login* `login u/USERNAME p/PASSWORD`
e.g. `login u/jalil p/dontworrybrother`
* *Add* `add n/NAME q/QUANTITY m/MINIMUM_QUANTITY [t/TAG]...` +
e.g. `add n/Arduino q/20 m/5 t/Lab1 t/Lab2`
* *Save* `save NAME` +
e.g. save ForAugust
* *Check* `check`
* *Changing status* `changeStatus n/NAME q/QUANTITY os/ORIGINALSTATUS ns/NEWSTATUS` +
e.g. `changeStatus n/Arduino q/20 os/Ready ns/Faulty`
* *Delete* : `delete INDEX q/QUANTITY` +
* *Edit* `edit INDEX n/NAME [q/QUANTITY] [m/MINIMUM_QUANTITY] [t/TAG]`
e.g. `edit 1 n/Arduino q/25 t/Lab7 t/Lab8`
* *Delete* `delete INDEX q/QUANTITY`
e.g. `delete 1 q/20`
* *Find* : `find KEYWORD [MORE_KEYWORDS]` +
e.g. `find n/Arduino`
* *List* : `all`
* *List by tag* : `list t/TAG` +
e.g. `list t/Lab5`
* *List item status* : `status`
* *Loan list* : `loanList n/NAME q/QUANTITY l/LOANER` +
* *List* `list`
* *Select* `select INDEX`
e.g. `select 1`
* *Clear* `clear`
* *Find* `find KEYWORD [MORE_KEYWORDS]`
e.g. `find Arduino`
* *Status* `status`
* *Change Status* `changeStatus n/NAME q/QUANTITY os/ORIGINALSTATUS ns/NEWSTATUS`
e.g. `changeStatus n/Arduino q/20 os/Ready ns/Faulty`
* *Loan List* `loanList n/NAME q/QUANTITY l/LOANER`
e.g. `loanList n/Arduino q/20 l/KinWhye`
* *Login* : `login u/USERNAME p/PASSWORD` +
e.g. `login u/jalil p/dontworrybrother`
* *Help* : `help`
* *History* : `history`
* *Undo* : `undo`
* *Update* : `update INDEX n/NAME [q/QUANTITY] [m/MINIMUM_QUANTITY] [t/TAG]` +
e.g. `update 1 n/Arduino q/25 t/Lab7 t/Lab8`
* *View Loan List* `viewLoanList`
* *Delete Loan List* `deleteLoanList INDEX`
e.g. `deleteLoanList 1`
* *Tag* `tag KEYWORD [MORE_KEYWORDS]`
e.g. `tag Lab1`
* *Add Tag* `addTag INDEX t/TAG [MORE_TAGS]`
e.g. `addTag 1 t/Lab2`
* *Delete Tag* `deleteTag INDEX t/TAG [MORE_TAGS]`
e.g. `deleteTag 1 t/Lab2`
* *Lost* : `lost INDEX [q/QUANTITY]` +
e.g. `lost 1 q/25`
* *Found* : `found INDEX [q/QUANTITY]` +
e.g. `found 1 q/25`
* *Lost&Found List* : `lost&found`
* *Tag* : `tag KEYWORD [MORE_KEYWORDS]` +
e.g. `tag Lab1`
* *Undo* : `undo`
* *Redo* : `redo`


* *History* : `history`
* *Save* `save NAME` +
e.g. `save ForAugust`
* *Open* `open NAME`
e.g. `open forAugust`
* *Exit* `exit`
57 changes: 29 additions & 28 deletions src/main/java/seedu/address/logic/parser/StockListParser.java
Original file line number Diff line number Diff line change
Expand Up @@ -62,58 +62,59 @@ public Command parseCommand(String userInput) throws ParseException {
final String arguments = matcher.group("arguments");
switch (commandWord) {

case HelpCommand.COMMAND_WORD:
return new HelpCommand();
case LoginCommand.COMMAND_WORD:
return new LoginCommandParser().parse(arguments);
case AddCommand.COMMAND_WORD:
return new AddCommandParser().parse(arguments);
case AddTagCommand.COMMAND_WORD:
return new AddTagCommandParser().parse(arguments);
case EditCommand.COMMAND_WORD:
return new EditCommandParser().parse(arguments);
case SelectCommand.COMMAND_WORD:
return new SelectCommandParser().parse(arguments);
case DeleteCommand.COMMAND_WORD:
return new DeleteCommandParser().parse(arguments);
case DeleteTagCommand.COMMAND_WORD:
return new DeleteTagCommandParser().parse(arguments);
case LostCommand.COMMAND_WORD:
return new LostCommandParser().parse(arguments);
case FoundCommand.COMMAND_WORD:
return new FoundCommandParser().parse(arguments);
case LostandFoundCommand.COMMAND_WORD:
return new LostandFoundCommand();
case ListCommand.COMMAND_WORD:
return new ListCommand();
case SelectCommand.COMMAND_WORD:
return new SelectCommandParser().parse(arguments);
case ClearCommand.COMMAND_WORD:
return new ClearCommand();
case FindCommand.COMMAND_WORD:
return new FindCommandParser().parse(arguments);
case TagCommand.COMMAND_WORD:
return new TagCommandParser().parse(arguments);
case ListCommand.COMMAND_WORD:
return new ListCommand();
case StatusCommand.COMMAND_WORD:
return new StatusCommand();
case ViewLoanListCommand.COMMAND_WORD:
return new ViewLoanListCommand();
case ChangeStatusCommand.COMMAND_WORD:
return new ChangeStatusCommandParser().parse(arguments);
case LoanListCommand.COMMAND_WORD:
return new LoanListCommandParser().parse(arguments);
case ViewLoanListCommand.COMMAND_WORD:
return new ViewLoanListCommand();
case DeleteLoanListCommand.COMMAND_WORD:
return new DeleteLoanListCommandParser().parse(arguments);
case LoginCommand.COMMAND_WORD:
return new LoginCommandParser().parse(arguments);
case HistoryCommand.COMMAND_WORD:
return new HistoryCommand();
case ExitCommand.COMMAND_WORD:
return new ExitCommand();
case HelpCommand.COMMAND_WORD:
return new HelpCommand();
case TagCommand.COMMAND_WORD:
return new TagCommandParser().parse(arguments);
case AddTagCommand.COMMAND_WORD:
return new AddTagCommandParser().parse(arguments);
case DeleteTagCommand.COMMAND_WORD:
return new DeleteTagCommandParser().parse(arguments);
case LostCommand.COMMAND_WORD:
return new LostCommandParser().parse(arguments);
case FoundCommand.COMMAND_WORD:
return new FoundCommandParser().parse(arguments);
case LostandFoundCommand.COMMAND_WORD:
return new LostandFoundCommand();
case UndoCommand.COMMAND_WORD:
return new UndoCommand();
case RedoCommand.COMMAND_WORD:
return new RedoCommand();
case ChangeStatusCommand.COMMAND_WORD:
return new ChangeStatusCommandParser().parse(arguments);
case HistoryCommand.COMMAND_WORD:
return new HistoryCommand();
case SaveCommand.COMMAND_WORD:
return new SaveCommandParser().parse(arguments);
case OpenCommand.COMMAND_WORD:
return new OpenCommandParser().parse(arguments);
case ExitCommand.COMMAND_WORD:
return new ExitCommand();

default:
throw new ParseException(MESSAGE_UNKNOWN_COMMAND);
}
Expand Down

0 comments on commit 5c00f00

Please sign in to comment.