Merge pull request #109 from hengyiqun/branch-notes

Branch notes

Author: hengyiqun

docs/UserGuide.md

@@ -24,7 +24,7 @@ MeetBuddy is a **desktop app for managing contacts and daily tasks, optimized fo
 1. Type the command in the command box and press Enter to execute it. e.g. typing **`help`** and pressing Enter will open the help window.<br>
    Some example commands you can try:
 
-   * **`list`** : Lists all contacts.
+   * **`listp`** : Lists all contacts.
 
    * **`add`**`n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01` : Adds a contact named `John Doe` to the Address Book.
 
@@ -83,24 +83,15 @@ Format: `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]…​`
 A person can have any number of groups (including 0)
 </div>
 
-* Assigning Priorities:
-
-  Format:
-
-  `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS pr/PRIORITY [no/NOTES] d/DATE`
-
-  PRIORITY can be {1,2,3,4,5}
-
-
 Examples:
 * `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
 * `add n/Betsy Crowe g/CS2103 e/betsycrowe@example.com a/Newgate Prison p/1234567 g/badminton`
 
-### Listing all persons : `list`
+### Listing all persons : `listp`
 
 Shows a list of all persons in the address book.
 
-Format: `list`
+Format: `listp`
 
 ### Editing a person : `edit`
 
@@ -109,7 +100,6 @@ Edits an existing person in the address book.
 Format: `edit INDEX [n/NAME] [p/PHONE] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​`
 
 * Edits the person at the specified `INDEX`. The index refers to the index number shown in the displayed person list. The index **must be a positive integer** 1, 2, 3, …​
-* At least one of the optional fields must be provided.
 * Existing values will be updated to the input values.
 * When editing groups, the existing groups of the person will be removed i.e adding of groups is not cumulative.
 * You can remove all the person’s groups by typing `g/` without
@@ -121,23 +111,36 @@ Examples:
 
 ### Locating persons by personName: `find`
 
-Finds persons whose names or whose groups contain any of the given keywords.
+Finds persons whose names contain any of the given keywords.
 
 Format: `find KEYWORD [MORE_KEYWORDS]`
 
 * The search is case-insensitive. e.g `hans` will match `Hans`
 * The order of the keywords does not matter. e.g. `Hans Bo` will match `Bo Hans`
-* Both the personName and group are searched.
+* Only the personName are searched.
 * Only full words will be matched e.g. `Han` will not match `Hans`
-* Persons whose personName or group matching at least one keyword will be returned (i.e. `OR` search).
-  e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
+* Persons matching at least one keyword will be returned (i.e. OR search). e.g. `Hans Bo` will return `Hans Gruber`, `Bo Yang`
 
 Examples:
 * `find John` returns `john` and `John Doe`
-* `find badminton` returns the list of contacts that are in the badminton group
 * `find alex david` returns `Alex Yeoh`, `David Li`<br>
   ![result for 'find alex david'](images/findAlexDavidResult.png)
 
+### Locating persons by personName: `findg`
+
+Finds persons whose groups contain any of the given keywords.
+
+Format: `findg KEYWORD [MORE_KEYWORDS]`
+
+* The search is case-insensitive. e.g `badminton` will match `Badminton`
+* The order of the keywords does not matter. e.g. `findg tennis table` will list every person in the table tennis group
+* Only the groups are searched.
+* Only full words will be matched e.g. `badminton` will not match `badmintons`
+* Persons whose group match at least one keyword will be returned (i.e. `OR` search).
+  
+Examples:
+* `findg badminton` returns the list of contacts that are in the badminton group
+
 ### Deleting a person : `delete`
 
 Deletes the specified person from the address book.
@@ -196,31 +199,52 @@ If your changes to the data file makes its format invalid, AddressBook will disc
 
 Adds a meeting to MeetBuddy.
 
-Format: `addm n/NAME st/TIME ed/TIME  des/DESCRIPTIONS pr/PRIORITY [p/PERSON RELATED] [g/GROUP]…​`
+Format: `addm n/NAME st/TIME ed/TIME des/DESCRIPTIONS pr/PRIORITY [p/PERSON RELATED]… [g/GROUP]…​`
 
 <div markdown="span" class="alert alert-primary">:bulb: **Tip:**
-A meeting can have any number of groups that are already existed in the contacts.(including 0) 
+A meeting can have any number of groups that are already existed in the contacts (including 0). 
 It will add all the persons belong to that group into the person related field.
 </div>
 
+### Listing all meetings : `listm`
 
+Shows a list of all meetings in the meeting book.
 
+Format: `listm`
 
-* Assigning Priorities:
+### Editing a meeting : `editm`
 
-  Format:
+Edits an existing meeting in the meeting book.
 
-  `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS pr/PRIORITY [no/NOTES] d/DATE`
+Format: `editm INDEX n/NAME st/START TIME ed/END TIME desc/DESCRIPTION pr/PRIORITY [g/GROUP]...​`
 
-  PRIORITY can be {1,2,3,4,5}
+* Edits the meeting at the specified `INDEX`. The index refers to the index number shown in the displayed meeting list. The index **must be a positive integer** 1, 2, 3, …​
+* Existing values will be updated to the input values.
+* When editing groups, the existing groups in the meeting will be removed i.e adding of groups is not cumulative.
+* You can remove all the meeting’s groups by typing `g/` without specifying any groups after it.
+
+Examples:
+*  `editm 1 n/CS2103 Lecture g/SOC g/friends` Edits the name of the 1st meeting to be `CS2103 Lecture`, and its groups to be `SOC` and `friends`.
+*  `editm 2 n/CS2106 Lab g/` Edits the name of the 2nd meeting to be `CS2106 Lab` and clears all existing groups in the meeting.
 
+### Deleting a meeting: `deletem`
+
+Deletes a meeting in the meeting book.
+
+Format: `deletem INDEX`
+
+* Deletes the meeting at the specified `INDEX`.
+* The index refers to the index number shown in the displayed meeting list.
+* The index **must be a positive integer** 1, 2, 3, …​
 
 Examples:
-* `add n/John Doe p/98765432 e/johnd@example.com a/John street, block 123, #01-01`
-* `add n/Betsy Crowe g/CS2103 e/betsycrowe@example.com a/Newgate Prison p/1234567 g/badminton`
+* `listm` followed by `delete 2` deletes the 2nd meeting in the meeting book.
 
-_Details coming soon ..._
+### Listing all persons and meetings : `list`
 
+Shows a list of all persons and meetings in MeetBuddy.
+
+Format: `list`
 --------------------------------------------------------------------------------------------------------------------
 
 ## FAQ
@@ -234,10 +258,10 @@ _Details coming soon ..._
 
 Action | Format, Examples
 --------|------------------
-**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]…​` <br> e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 g/CS2106 g/badminton`
+**Add** | `add n/NAME p/PHONE_NUMBER e/EMAIL a/ADDRESS [g/GROUP]…​` <br> e.g., `add n/James Ho p/22224444 e/jamesho@example.com a/123, Clementi Rd, 1234665 g/CS2106 g/badminton` <br> <br> `addm n/NAME st/START TIME ed/END TIME desc/DESCRIPTION pr/PRIORITY [g/GROUP]...[p/INDEX OF PERSON RELATED]...​` <br> e.g., `addm n/CS2103 Lecture st/2021-03-12 14:00 ed/2021-03-12 16:00 desc/Week 7 pr/3 g/lectures g/SoC p/1 p/2`
 **Clear** | `clear`
-**Delete** | `delete INDEX`<br> e.g., `delete 3`
-**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com`
-**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake`
-**List** | `list`
+**Delete** | `delete INDEX`<br> e.g., `delete 3` <br> <br> `deletem INDEX`<br> e.g., `delete 3`
+**Edit** | `edit INDEX [n/NAME] [p/PHONE_NUMBER] [e/EMAIL] [a/ADDRESS] [g/GROUP]…​`<br> e.g.,`edit 2 n/James Lee e/jameslee@example.com` <br> <br> `editm n/NAME st/START TIME ed/END TIME desc/DESCRIPTION pr/PRIORITY [g/GROUP]...[p/INDEX OF PERSON RELATED]...​`<br> e.g.,`edit 2 n/CS2103 Lecture`
+**Find** | `find KEYWORD [MORE_KEYWORDS]`<br> e.g., `find James Jake` <br> <br> `findg KEYWORD [MORE_KEYWORDS]`<br> e.g., `findg badminton` <br>
+**List** | `list`, `listm`, `listp`
 **Help** | `help`

src/main/java/seedu/address/logic/commands/meetings/EditMeetingCommand.java

@@ -34,7 +34,8 @@ public class EditMeetingCommand extends Command {
             + PREFIX_END_TIME + "END TIME "
             + PREFIX_DESCRIPTION + "DESCRIPTION "
             + PREFIX_PRIORITY + "PRIORITY "
-            + "[" + PREFIX_GROUP + "GROUP]...\n"
+            + "[" + PREFIX_GROUP + "GROUP]..."
+            + "[" + PREFIX_PERSON_CONNECTION + "INDEX OF PERSON RELATED]...\n"
             + "Example: " + COMMAND_WORD + " 1 "
             + PREFIX_NAME + "CS2103 Lecture "
             + PREFIX_START_TIME + "2021-03-12 14:00 "