[CS2113-T17-4] parKING #11

malcolmang · 2022-09-29T09:30:01Z

A parking CLI that helps drivers choose the best place to park.

gaoyunfan · 2022-10-26T04:10:10Z

docs/DeveloperGuide.md


-## Design & implementation
+#### Model Component
+![Model Class Diagram](images/ModelClassDiagram.png)


I think the format for method's parameter-list in class diagram is name: type for carparkList

gaoyunfan · 2022-10-26T04:24:53Z

docs/DeveloperGuide.md

@@ -1,12 +1,186 @@
 # Developer Guide



Maybe could included an intro about ur project

paullowse · 2022-10-26T04:16:49Z

docs/DeveloperGuide.md

+
+#### Common Files
+
+## Implementation


Implementation not done yet, do add it when you can!

paullowse · 2022-10-26T04:19:02Z

docs/DeveloperGuide.md

+- Authenticate user API key. If no user key inputted, default key will be loaded.
+- Get API authentication status.
+
+#### Storage Component


Do add the other components too!!

paullowse · 2022-10-26T04:21:12Z

docs/DeveloperGuide.md

+
+## Design 
+
+### Architecture Level


Do add the architecture level section!

paullowse · 2022-10-26T04:23:40Z

docs/DeveloperGuide.md

+See [`FileLoader`](#FileLoader) for more information.
+
+#### API Component
+![API Class Diagram](images/ApiClassDiagram.png)


Perhaps the uml visibility symbols such as + or - should be used instead

gaoyunfan · 2022-10-26T04:32:07Z

docs/DeveloperGuide.md

+
+The following sequence diagrams shows how a favourite / unfavourite command works:
+
+![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


inconsistent in labelling of return value. There is no label for return findcarpark() call.

gaoyunfan · 2022-10-26T04:39:48Z

docs/DeveloperGuide.md

+
+### Favourite / Unfavourite feature
+
+![Favourite Class Diagram](images/FavouriteClassDiagram.png)


perhaps can add in the multiplicity of Favourite

paullowse · 2022-10-26T04:48:56Z

docs/DeveloperGuide.md

+Note: The `Carpark` class contain many getters, setters and annotations to be used with the `jackson` module. 
+See [`FileLoader`](#FileLoader) for more information.
+
+#### API Component


Would be good to add labels for the arrows in the uml to make it clear

paullowse · 2022-10-26T04:51:55Z

docs/DeveloperGuide.md

+
+![Favourite Class Diagram](images/FavouriteClassDiagram.png)
+
+#### Implementation


The write up of the implementation is pretty clear, with good bullet points and segmentation. Good job!

nshian

Overall, an informative guide with some suggestions for your consideration

nshian · 2022-10-26T05:26:28Z

docs/DeveloperGuide.md


-{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
+### Component Level


Parameter-list for methods should be of the form [name of variable] : [type of variable] e.g. setNumber(n: Integer)

nshian · 2022-10-26T05:36:54Z

docs/DeveloperGuide.md

+
+### Favourite / Unfavourite feature
+
+![Favourite Class Diagram](images/FavouriteClassDiagram.png)


Maybe you want to consider including the multiplicity of the Favourite class as well? Since the other associations you have included have multiplicities on both ends

nshian · 2022-10-26T05:42:17Z

docs/DeveloperGuide.md

+
+The following sequence diagrams shows how a favourite / unfavourite command works:
+
+![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


Perhaps you might want to write the [condition] in the alt block in normal prose? e.g. user favourites list, user favourites a specific carpark by ID

nshian · 2022-10-26T05:44:52Z

docs/DeveloperGuide.md

+
+The following sequence diagrams shows how a favourite / unfavourite command works:
+
+![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


Consider adding a label for the return value for the findCarpark() method?

nshian · 2022-10-26T05:45:41Z

docs/DeveloperGuide.md

+1. Land Transport Authority DataMall API Service ([link](https://datamall.lta.gov.sg/content/datamall/en.html)).
+2. Jackson JSON Parser ([link](https://fasterxml.github.io/jackson-core/javadoc/2.8/com/fasterxml/jackson/core/JsonParser.html))
+
+## Design 


More sequence diagrams for some other commands would be nice

dhanish265 · 2022-10-28T03:15:30Z

docs/DeveloperGuide.md

+
+#### Common Files
+
+## Implementation


 ## Product scope


referring to line 229, ## User Stories

please consider adding more user stories

dhanish265 · 2022-10-28T03:21:23Z

docs/DeveloperGuide.md

+
+
+
+#### Design considerations


can consider resizing the image of the sequence diagram used for increased clarity

dhanish265 · 2022-10-28T03:28:03Z

docs/DeveloperGuide.md

-{Describe the design and implementation of the product. Use UML diagrams and short code snippets where applicable.}
+#### API Component
+![API Class Diagram](images/ApiClassDiagram.png)
+


the chunk of text is hard to grasp/understand. perhaps, you can reduce the number of words/simplify the explanation

dhanish265 · 2022-10-28T03:30:39Z

docs/DeveloperGuide.md

+- changeScanner() - Changes the scanner for the Ui object. To be used for JUnit testing.
+- getSeparatorString() - Returns a separator string.
+
+#### Logic Component


unclear what is XYZCommand in the diagram, not described in your description as well.

kohnh

LGTM

kohnh · 2022-10-28T03:19:05Z

docs/DeveloperGuide.md

+#### Storage Component
+
+#### Implementation
+![Sequence Diagram](images/LoadFileSequenceDiagram.png)


consider adding a "X" at the end of the lifeline of an object to show its deletion

kohnh · 2022-10-28T03:26:53Z

docs/DeveloperGuide.md

+### Component Level
+
+#### Model Component
+![Model Class Diagram](images/ModelClassDiagram.png)


Should use the symbols taught in class like + or -

kohnh · 2022-10-28T03:36:25Z

docs/DeveloperGuide.md

+
+The following sequence diagrams shows how a favourite / unfavourite command works:
+
+![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


Both alts seems similar except for the command call, maybe can combine the 2

kohnh · 2022-10-28T03:36:58Z

docs/DeveloperGuide.md

+
+The following sequence diagrams shows how a favourite / unfavourite command works:
+
+![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


Maybe you can make the diagram bigger for easier reading. The diagram is also not sharp.

kohnh · 2022-10-28T03:38:02Z

docs/DeveloperGuide.md

+
+### Favourite / Unfavourite feature
+
+![Favourite Class Diagram](images/FavouriteClassDiagram.png)


Maybe you can remove the circle for class as it is not taught in class.

kohnh · 2022-10-28T03:41:48Z

docs/DeveloperGuide.md

+- Get API authentication status.
+
+The following sequence diagram shows how the API key is loaded.
+![Api Loading Sequnce Diagram](images/LoadApiSequenceDiagram.png)


The origin of this arrow is unclear. Maybe you should include what the storage class calls in order to return the API_KEY

exetr

Good use of the three types of diagrams to augment elaboration of your application. Most of the diagrams are fine, although do be careful of the small details such as the format of header for class diagrams and the visibilty specifer for objects to follow the format stated by the module specifications.

exetr · 2022-10-29T15:55:22Z

docs/DeveloperGuide.md

+### Component Level
+
+#### Model Component
+![Model Class Diagram](images/ModelClassDiagram.png)


Double check your attribute and operations visibility identifiers, they should align with the module's specifications

exetr · 2022-10-29T16:08:24Z

docs/DeveloperGuide.md


-## Design & implementation
+Note: The `Carpark` class contain many getters, setters and annotations to be used with the `jackson` module. 
+See [`FileLoader`](#FileLoader) for more information.


Minor issue, but currently the fileloader link is broken, do double check it.

exetr · 2022-10-29T16:09:15Z

docs/DeveloperGuide.md

+* Only reads from the secret.txt file once and stores the API as a variable (will only read from the file
+if requested again).
+
+How the API component of data fetching works


For specificity, you may want to consider what type of data you are pulling from the API.

exetr · 2022-10-29T16:11:21Z

docs/DeveloperGuide.md

+#### Storage Component
+
+#### Implementation
+![Sequence Diagram](images/LoadFileSequenceDiagram.png)


This sequence diagram seems overly complicated, do try to re-visit whether it is necessary to depict every aspect of the sequence diagram. If it is requried, you can potentially consider splitting it up into multiple diagrams, or using ref frames.

exetr · 2022-10-29T16:12:20Z

docs/DeveloperGuide.md

+* All `ABCCommand` classes will have an override `execute` method, which will override the `execute` method in `Command` 
+and return the respective `CommandResult` result of the Command.
+
+![Logic Class Diagram](images/LogicClassDiagram.png)


Is the XYZCommand class redundant? If so, do consider removing it

exetr · 2022-10-29T16:12:55Z

docs/DeveloperGuide.md

+* All `ABCCommand` classes will have an override `execute` method, which will override the `execute` method in `Command` 
+and return the respective `CommandResult` result of the Command.
+
+![Logic Class Diagram](images/LogicClassDiagram.png)


Same case here, do double check that you use the correct visibilty indicators as specified by the module.

exetr · 2022-10-29T16:15:01Z

docs/DeveloperGuide.md

+
+The following sequence diagrams shows how a favourite / unfavourite command works:
+
+![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


Consider enlarging the size of this sequence diagram for greater clarity.

Updated user guide

Branch more ug fix

…e file is changed manually

Branch pe d fixes

Add enhancements and fix bugs

…into branch-Favourite-enhancement # Conflicts: # src/main/java/seedu/commands/FavouriteCommand.java

Edit ToC

Change favourite list to throw the correct exception

Add examples for manual testing

Branch ppp

…into branch-UG-change

Add disclaimer about tampering with file permissions

…into branch-DG-acknowledgements

DG acknowledgements

Fix broken markdown

Branch dgug edits

update PPP Malcolm Ang

gaoyunfan reviewed Oct 26, 2022

View reviewed changes

docs/DeveloperGuide.md

@@ -1,12 +1,186 @@

# Developer Guide

Copy link

gaoyunfan Oct 26, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe could included an intro about ur project

paullowse reviewed Oct 26, 2022

View reviewed changes

gaoyunfan reviewed Oct 26, 2022

View reviewed changes

paullowse reviewed Oct 26, 2022

View reviewed changes

nshian reviewed Oct 26, 2022

View reviewed changes

dhanish265 reviewed Oct 28, 2022

View reviewed changes

kohnh reviewed Oct 28, 2022

View reviewed changes

exetr reviewed Oct 29, 2022

View reviewed changes

pipipipi2002 and others added 20 commits October 31, 2022 14:47

Updated user guide

c6a4f14

Merge pull request #165 from pipipipi2002/branch-fix-UG-Bug-postv2

4fdf33b

Updated user guide

fix ui bug

ae6a986

Fix table hyperlinks

2430772

added table of contents

218c0c3

Update quick start

4037329

added more detail for the filter and find command

348d636

Added shorthands to UG

1dd2774

Added shorthands to the help comand

a3583df

Merge pull request #167 from pipipipi2002/branch-moreUGfix

d85ba98

Branch more ug fix

Fix bug regarding command 'favourite list' not working after favourit…

65e2585

…e file is changed manually

Add 'isCarparkValid' method to check if carpark id is valid

1b10793

Add 'replaceFavouriteList' method to overwrite current ArrayList

cbe11ba

Modify to fit checkstyle

28a1238

Merge branch 'master' into branch-PE-D-fixes

5dcb206

Merge pull request #168 from eehongchan/branch-PE-D-fixes

1fe0d23

Branch pe d fixes

Add support for favouriting multiple carparks at once

d3248ca

Fix loading bug with input validation

d83513e

Merge pull request #169 from malcolmang/branch-2.1-enhancements

96d3590

Add enhancements and fix bugs

Merge branch 'master' of https://github.com/AY2223S1-CS2113-T17-4/tp …

adba322

…into branch-Favourite-enhancement # Conflicts: # src/main/java/seedu/commands/FavouriteCommand.java

malcolmang and others added 30 commits November 7, 2022 18:31

Edit ToC

9cfd4d2

Merge pull request #235 from malcolmang/branch-edit-TOC

77439b1

Edit ToC

Change favourite list to throw the correct exception

7336466

Merge pull request #236 from malcolmang/branch-emergency-bug-fixes

638d342

Change favourite list to throw the correct exception

Add examples for manual testing

bee0f23

Merge pull request #237 from eehongchan/branch-DG-draft

0556ba6

Add examples for manual testing

Add NFRs and edit expected output for manual testing

8896623

Update PPP

54e7413

Merge pull request #238 from eehongchan/branch-PPP

495fb25

Branch ppp

Add disclaimer about tampering with permissions

54c16e2

Merge branch 'master' of https://github.com/AY2223S1-CS2113-T17-4/tp …

4725f1e

…into branch-UG-change

Merge pull request #239 from malcolmang/branch-UG-change

3932c77

Add disclaimer about tampering with file permissions

UG acknowledgements

6220838

Merge branch 'master' of https://github.com/AY2223S1-CS2113-T17-4/tp …

1c6e5c5

…into branch-DG-acknowledgements

Merge pull request #240 from malcolmang/branch-DG-acknowledgements

6d8f3f5

DG acknowledgements

Fix broken markdown

8c40b84

Merge pull request #241 from malcolmang/branch-markdown-fix

f6c1257

Fix broken markdown

edit UG

8ec6e36

edited DG

7b9e243

Merge pull request #242 from kyrenechua/branch-DGUG-Edits

8fbe240

Branch dgug edits

edited UG

1bf8f02

edited DG

5f20c2d

edited DG

e388bc8

edit user stories

7097189

Merge pull request #243 from kyrenechua/branch-DGUG-Edits

3ea8e52

Branch dgug edits

update PPP

856d8c9

Merge pull request #244 from malcolmang/branch-modify-PPP

d90418e

update PPP Malcolm Ang

Update malcolmang.md

3059302

Update malcolmang.md

535d3a8

Update malcolmang.md

3d9d5b1


		The following sequence diagrams shows how a favourite / unfavourite command works:

		![Favourite Sequence Diagram](images/FavouriteSequenceDiagram.png)


		### Favourite / Unfavourite feature

		![Favourite Class Diagram](images/FavouriteClassDiagram.png)


		![Favourite Class Diagram](images/FavouriteClassDiagram.png)

		#### Implementation


		{list here sources of all reused/adapted ideas, code, documentation, and third-party libraries -- include links to the original source as well}
		### Component Level

[CS2113-T17-4] parKING #11

Are you sure you want to change the base?

[CS2113-T17-4] parKING #11

Conversation

malcolmang commented Sep 29, 2022

gaoyunfan Oct 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nshian left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kohnh left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

exetr left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

gaoyunfan Oct 26, 2022 •

edited

Loading