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

A-JavaDoc #8

Closed
therizhao opened this issue Aug 22, 2020 · 0 comments · Fixed by #18
Closed

A-JavaDoc #8

therizhao opened this issue Aug 22, 2020 · 0 comments · Fixed by #18
Assignees
@therizhao
Labels
documentation Improvements or additions to documentation

Comments

@therizhao
Copy link
Owner

Add JavaDoc comments

Add JavaDoc comments to the code.

Minimal: Add header comments to at least half of the non-private classes/methods.
Stretch goal: Add header comments to all non-private classes/methods, and non-trivial private methods.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@therizhao therizhao

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

docs(A-JavaDoc): Add javadocs for classes and their public methods therizhao/ip
1 participant
@therizhao