Updated Developer Guide #1
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
justinpoh
reviewed
Oct 22, 2017
|
|
||
| ==== UI component | ||
|
|
||
| UI component provides with the API of Graphical User Interface. The figure below shows the structure of the UI component. |
There was a problem hiding this comment.
UI component provides with the API of GUI...what does this mean?
"The UI component provides the API to interact with the Graphical User Interface..."?
justinpoh
reviewed
Oct 22, 2017
| _Figure 8 : Interactions inside the Logic component for the `delete 1` command_ | ||
|
|
||
| ==== Model component | ||
| Model Component handles the contacts in address book and all it's stored details in data structures which provides API to create, read, update and delete the contacts in address book. The figure below shows the structure of Model component. |
There was a problem hiding this comment.
The Model component...
The figure below shows the structure of the Model component.
justinpoh
reviewed
Oct 22, 2017
|
|
||
| * stores a `UserPref` object that represents the user's preferences. | ||
| * stores the Address Book data. | ||
| * exposes an unmodifiable `ObservableList<ReadOnlyPerson>` that can be 'observed' e.g. the UI can be bound to this list so that the UI automatically updates when the data in the list change. | ||
| * does not depend on any of the other three components. | ||
|
|
||
| === Storage component | ||
| ==== Storage component | ||
| The storage component handles the storage of all data of address book in the local device. The figure below shows the structure of Storage component. |
There was a problem hiding this comment.
The Storage component handles...
...shows the structure of the Storage component.
justinpoh
reviewed
Oct 22, 2017
docs/DeveloperGuide.adoc
Outdated
| @@ -302,9 +317,9 @@ The `ExportCommand` uses `XmlAddressBookStorage` class to generate a xml file ba | |||
| } | |||
| ---- | |||
|
|
|||
| The method `getRangefromInput()` splits the String range using the regex "," and returns a String array for the different values in the String range. | |||
| The method `getRangefromInput()` splits the `String` range using the regex `","` and returns a `String` array for the different values in the `String` range. | |||
There was a problem hiding this comment.
I think using delimiter instead of regex sounds better.
justinpoh
reviewed
Oct 22, 2017
docs/DeveloperGuide.adoc
Outdated
| @@ -315,16 +330,16 @@ private String[] getRangeFromInput() { | |||
| } | |||
| ---- | |||
|
|
|||
| To determine which contacts should be added to the exportBook we have to check the the user input, there are 3 cases: | |||
| To determine which contacts should be added to the `exportBook` we have to check the the user input, there are three cases: | |||
There was a problem hiding this comment.
double "the"
I think we turn the comma into a full stop and start a new sentence:
To determine which contacts should be added to the exportBook we have to check the user input. There are three cases:
justinpoh
reviewed
Oct 22, 2017
docs/DeveloperGuide.adoc
Outdated
| @@ -517,7 +540,7 @@ The binder for refreshing the image every time the picture is updated is impleme | |||
| } | |||
| ---- | |||
|
|
|||
| The new image stored in directory is given a unique name which is formed using hashcode of the unique email address of each contact. | |||
| The new image stored in directory is given a unique name which is formed using hashcode of the unique email address of each contact: | |||
There was a problem hiding this comment.
"...formed by hashing the unique email address of each contact:"
justinpoh
reviewed
Oct 22, 2017
| * By specifying the index, there is no ambiguity as to who should be assigned the display picture. | ||
| * The `PATHOFIMAGE` must be an absolute path on the local device to make sure the image is referenced. | ||
| * The image is stored in directory with a unique name to avoid conflict. Hashcode of user's email address is used to maintain uniqueness. | ||
| * The task is done using CLI to follow project requirements. |
justinpoh
reviewed
Oct 22, 2017
| **Pros:** Easier for new developers to understand the sequence diagram and maintains event-driven nature. + | ||
| **Cons:** There might be clash in naming of two different images for large database of contacts | ||
| **Cons:** There might be clashes in naming of two different images for large database of contacts. |
justinpoh
reviewed
Oct 22, 2017
| **Alternative 2:** Pop up a `FileChooser` after command is entered + | ||
| **Pros:** Easier for users to mention the correct image at a quick pace + | ||
| **Cons:** Will no longer be a CLI process completely | ||
| **Cons:** Might be problematic for user to copy and paste and might result in error of path giving fail command. + |
There was a problem hiding this comment.
Might be problematic for users to copy and paste, and this might result in an erroneous path given, leading to an invalid command.
justinpoh
reviewed
Oct 22, 2017
| **Cons:** Will no longer be a CLI process completely | ||
| **Cons:** Might be problematic for user to copy and paste and might result in error of path giving fail command. + | ||
| **Alternative 2:** Pop up a `FileChooser` after command is entered. + | ||
| **Pros:** Easier for users to mention the correct image quickly. + |
Weiwen edit dg
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.