Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update ui with javadocs #179

Merged

Conversation

seanjyjy
Copy link

Pr Overview

  • Update java docs for all UI classes
  • Reformat some code in UI.

@seanjyjy seanjyjy self-assigned this Oct 17, 2020
@seanjyjy seanjyjy added this to the v1.3 milestone Oct 17, 2020
@codecov-io
Copy link

codecov-io commented Oct 17, 2020

Codecov Report

Merging #179 into master will decrease coverage by 0.03%.
The diff coverage is 0.00%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #179      +/-   ##
============================================
- Coverage     36.05%   36.02%   -0.04%     
  Complexity      557      557              
============================================
  Files           173      173              
  Lines          3309     3312       +3     
  Branches        391      391              
============================================
  Hits           1193     1193              
- Misses         2042     2045       +3     
  Partials         74       74              
Impacted Files Coverage Δ Complexity Δ
...va/seedu/address/logic/commands/SwitchCommand.java 83.33% <ø> (ø) 3.00 <0.00> (ø)
src/main/java/seedu/address/ui/CommandBox.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/ExitDialog.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/HelpWindow.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/MainWindow.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/ResultDisplay.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/UiManager.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/UiPart.java 84.00% <ø> (ø) 4.00 <0.00> (ø)
...n/java/seedu/address/ui/cards/ApplicationCard.java 0.00% <0.00%> (ø) 0.00 <0.00> (ø)
src/main/java/seedu/address/ui/cards/Card.java 0.00% <ø> (ø) 0.00 <0.00> (ø)
... and 15 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 21b9718...5b5c853. Read the comment docs.

Copy link

@orzymandias orzymandias left a comment

Choose a reason for hiding this comment

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

Looks good, just some minor nits with Javadocs to comply with coding standard

*/
private Optional<ListPanel<? extends Item>> setProfileTabView() {
return Optional.of(new ProfileListPanel(profileItems));
}

/**
* todo javadocs

Choose a reason for hiding this comment

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

Javadoc could perhaps start with Switches.... depending on

Copy link
Author

Choose a reason for hiding this comment

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

resolved in the latest push.

@@ -1,5 +1,8 @@
package seedu.address.ui.cards;

/**

Choose a reason for hiding this comment

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

Perhaps you could change it to Represents a class...

Copy link
Author

Choose a reason for hiding this comment

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

resolved in the latest push.

*/
private void setInformationTitle() {
Object jobTitle = mapping.get(TITLE_DISPLAY_NAME);
setInformationTitle(jobTitle.toString());
}

/**
* todo javadocs
* Set the information of the {@code profileItem} for display.

Choose a reason for hiding this comment

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

Start with sets..

Copy link
Author

Choose a reason for hiding this comment

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

resolved in the latest push.

…into update-ui-with-javadocs

� Conflicts:
�	src/main/java/seedu/address/ui/display/ApplicationDisplay.java
�	src/main/java/seedu/address/ui/display/CompanyDisplay.java
�	src/main/java/seedu/address/ui/display/ProfileDisplay.java
Copy link

@keanecjy keanecjy left a comment

Choose a reason for hiding this comment

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

LGTM

@keanecjy keanecjy merged commit d2b161a into AY2021S1-CS2103T-T15-4:master Oct 18, 2020
@seanjyjy seanjyjy added the Code label Nov 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants