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

javadocs #12

Closed
larocquemb opened this issue Aug 14, 2020 · 1 comment
Closed

javadocs #12

larocquemb opened this issue Aug 14, 2020 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@larocquemb
Copy link

code should be documented with docstrings
https://www.oracle.com/technical-resources/articles/java/javadoc-tool.html
https://www.tutorialspoint.com/java/java_documentation.htm
@dlarocque dlarocque added the documentation Improvements or additions to documentation label Aug 18, 2020
@dlarocque
Copy link
Owner

Java documentation doesn't seem necessary here as this code isn't going to be used by other developers.
Added comments to help anyone who wants to understand the code or add something in the future instead.
a1ce5ef

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

No branches or pull requests
2 participants
@larocquemb @dlarocque