Merge pull request #62 from abtyx/v1.3UserDocAsh

update userdoc for privacy command
CS2103-AY1819S1-T13-2 · Oct 31, 2018 · 4ceaf6f · 4ceaf6f
2 parents 5b10b49 + 988b5c6
commit 4ceaf6f
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 3 deletions.
diff --git a/docs/UserGuide.adoc b/docs/UserGuide.adoc
@@ -54,6 +54,7 @@ adds a staff named `John Doe` to SSENISUB.
 `{nbsp}` (i.e. 0 times), `t/staff`, `t/manager` etc.
 * Parameters can be in any order e.g. if the command specifies `n/NAME p/PHONE_NUMBER`, `p/PHONE_NUMBER n/NAME` is also acceptable.
 * Adding a 'p' infront of the parameter private. e.g. pp/PHONE makes the phone number private to the other user.
+* Only `PHONE`, `EMAIL` and `ADDRESS` fields can be initialized as private.
 ====
 
 === Viewing help : `help`
@@ -249,6 +250,19 @@ Format: `lock PASSWORD`
 Unlocks the SSENISUB with a specified password. +
 Format: `unlock PASSWORD`
 
+=== Setting private fields: `privacy`
+
+Sets the mentioned field into a private field(will not display on the panel). +
+Format: `privacy INDEX [n/ y or n] [e/ y or n] [a/ y or n]`
+
+****
+* Modifies the privacy of the information of the staff at the specified `INDEX`.
+* The index refers to the index number shown in the displayed staff list.
+* The index *must be a positive integer* 1, 2, 3, ...
+* Only Phone, Email and Address can be set to private.
+* 'y' means setting to private and 'n' means setting to public.
+****
+
 === Saving the data
 
 SSENISUB data are saved in the hard disk automatically after any command that changes the data. +
@@ -290,6 +304,8 @@ e.g. `sort ASCENDING`
 * *Help* : `help`
 * *Select* : `select INDEX` +
 e.g.`select 2`
+* *Privacy* : `privacy INDEX [n/ y or n] [e/ y or n] [a/ y or n]` +
+e.g. `privacy 2 n/y a/n`
 * *History* : `history`
 * *Undo* : `undo`
 * *Redo* : `redo`

diff --git a/src/main/java/seedu/address/logic/commands/AddCommand.java b/src/main/java/seedu/address/logic/commands/AddCommand.java
@@ -24,9 +24,9 @@ public class AddCommand extends Command {
     public static final String MESSAGE_USAGE = COMMAND_WORD + ": Adds a person to the address book. "
             + "Parameters: "
             + PREFIX_NAME + "NAME "
-            + PREFIX_PHONE + "PHONE "
-            + PREFIX_EMAIL + "EMAIL "
-            + PREFIX_ADDRESS + "ADDRESS "
+            + "[p]" + PREFIX_PHONE + "PHONE "
+            + "[p]" + PREFIX_EMAIL + "EMAIL "
+            + "[p]" + PREFIX_ADDRESS + "ADDRESS "
             + PREFIX_DEPARTMENT + "DEPARTMENT "
             + PREFIX_MANAGER + "MANAGER "
             + "[" + PREFIX_TAG + "TAG]...\n"