Skip to content

[CS2113T-T09-4] traKCAL#29

Open
1-Karthigeyan-1 wants to merge 1240 commits into
nus-cs2113-AY2021S1:masterfrom
AY2021S1-CS2113T-T09-4:master
Open

[CS2113T-T09-4] traKCAL#29
1-Karthigeyan-1 wants to merge 1240 commits into
nus-cs2113-AY2021S1:masterfrom
AY2021S1-CS2113T-T09-4:master

Conversation

@1-Karthigeyan-1

Copy link
Copy Markdown

PR subject: traKCAL
Description: traKCAL helps university students to track their calories over a period of time.

@Mick609

Mick609 commented Oct 28, 2020

Copy link
Copy Markdown

Maybe you guys should change the title of the project to CS2113T-T09-4. The current title is missing a T.

Comment thread docs/DeveloperGuide.md Outdated

**trakCAL** is made up of mainly 6 components.

`trakCAL`: tracKCAL starts here

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Should the user talk to the UI component instead? What is the meaning of the trackCAL component? Is it something like the main() function? Maybe the team should explain more

Comment thread docs/DeveloperGuide.md

![Logic Component](diagrams/LogicComponent.png)

*Figure 2. Diagram for logic component*

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

image
Maybe you can change the arrowhead to another type to make it more clear that is an association.

Comment thread docs/DeveloperGuide.md

![Logic Component](diagrams/LogicComponent.png)

*Figure 2. Diagram for logic component*

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Perhaps can specify that it is a UML diagram? Or is it not?

Comment thread docs/DeveloperGuide.md

### 2.3 Model component

![Model_Component](diagrams/model.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

image
I like the arrowhead in the blue circle, the one in the red circle might cause confusion.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think can include multiplicity in the diagram to make it clear the ActivityList contains multiple Activity objects.

Comment thread docs/DeveloperGuide.md

**API**: Model.java

In the Model component,

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Some grammar errors here

Comment thread docs/DeveloperGuide.md Outdated

The sequence diagram below shows how the components will react to a new user or for a returning user.

![CreateNewUser](diagrams/CreateNewUser.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

image
Is there an error in the red circle? Should the incoming arrow from the left go to the name box as it is a constructor? And which function calls the data for user profile function?

Comment thread docs/DeveloperGuide.md Outdated
Comment on lines +269 to +271
The graph implementation shows the progress of the daily net
calories over the period of 7 days. The GraphProperty class extracts the available days from the
hashmap.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I think this part should be written after the diagram is introduced.

Comment thread docs/DeveloperGuide.md
is created, the properties of the graph are then stored and calculated in setProperty function.

Next, the graphDrawing object is created and uses the properties calculated earlier to print out the graph.
> In the case where there are less than 7 days stored, all the days will be displayed.

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

I like the way you present this extra information.

Comment thread docs/DeveloperGuide.md

The following sequence diagram shows how the `move` command is executed, where index1 is the position to be moved from and index 2 is the position to be moved below.

![Move_command](diagrams/moveCommand.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

image
Is this arrowhead a typo?

Comment thread docs/DeveloperGuide.md

The following sequence diagram shows how the lastSeenList is set after a “list date" command where date is of YYYY-MM-DD or after a “list” command where the date is the current date.

![Listing feature for find and list commands](diagrams/setLastSeenList.png)

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

The diagram looks good.

@1-Karthigeyan-1 1-Karthigeyan-1 changed the title [CS2113-T09-4] traKCAL [CS2113T-T09-4] traKCAL Nov 7, 2020
poonchuanan and others added 30 commits November 9, 2020 23:36
…into owen-DG

# Conflicts:
#	docs/UserGuide.md
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants