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.

Sign up for GitHub

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

Jump to bottom

Correct and finish javadoc documentation #56

Open
jalexanderqed opened this issue Sep 27, 2016 · 3 comments
Open

Correct and finish javadoc documentation #56

jalexanderqed opened this issue Sep 27, 2016 · 3 comments

Comments

@jalexanderqed
Copy link
Contributor

Many methods and classes completely lack descriptions. For example Score.java lacks any javadoc comments.
Some method descriptions incorrectly specify what the method does and/or do not list the correct parameters. For example, runnerHasCollided() in CountryRunnerJPanel.java.
As you work through the project, added javadoc comments indicating the purpose of and functionality provided by each class and method.
@jalexanderqed
Copy link
Contributor Author

jalexanderqed commented Sep 27, 2016 •
edited
Loading

F16 OK (100 pts)

@UCSBWillHuang1997 UCSBWillHuang1997 mentioned this issue Nov 23, 2016
Merged
@jalexanderqed
Copy link
Contributor Author

The JavaDoc was improved during F16. However, a large number of warnings are still thrown. Try to fix all of these errors.

@Sierrasch
Copy link
Contributor

W18 OK (75 pts)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@jalexanderqed @Sierrasch