Skip to content

Commit

Permalink
Update User Guide and Developer Guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Zhiyuan-Amos committed Jul 21, 2017
1 parent d59c5db commit 1f44338
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 1 deletion.
3 changes: 3 additions & 0 deletions docs/DeveloperGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,9 @@ Author: Bernard Choo
image::LogicClassDiagram.png[width="800"]
_Figure 2.3.1 : Structure of the Logic Component_

image::LogicCommandClassDiagram.png[width="800"]
_Figure 2.3.2 : Structure of Commands in the Logic Component. This diagram shows finer details concerning `XYZCommand` and `Command` in Figure 2.3.1_

*API* :
link:{repoURL}/src/main/java/seedu/address/logic/Logic.java[`Logic.java`]

Expand Down
52 changes: 51 additions & 1 deletion docs/UserGuide.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ Returns Any person having names `Betsy`, `Tim`, or `John`

=== Deleting a person : `delete`

Deletes the specified person from the address book. Irreversible. +
Deletes the specified person from the address book. +
Format: `delete INDEX`

****
Expand Down Expand Up @@ -160,6 +160,54 @@ Format: `history`
Pressing the kbd:[↑] and kbd:[↓] arrows will display the previous and next input respectively in the command box.
====

=== Undo 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) +

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

Reverses the most recent `undo` command. +
Format: `redo`

Examples:

* `delete 1` +
`undo` (reverses the `delete 1` command) +
`redo` (reapplies the `delete 1` command) +

* `delete 1` +
`redo` +
The `redo` command fails as there are no `undo` commands executed previously.

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

=== Clearing all entries : `clear`

Clears all entries from the address book. +
Expand Down Expand Up @@ -194,3 +242,5 @@ e.g. `find James Jake`
* *Select* : `select INDEX` +
e.g.`select 2`
* *History* : `history`
* *Undo* : `undo`
* *Redo* : `redo`
Binary file modified docs/diagrams/LogicComponentClassDiagram.pptx
Binary file not shown.
Binary file not shown.
Binary file modified docs/images/LogicClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/LogicCommandClassDiagram.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1f44338

Please sign in to comment.