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

Add method summaries as java doc #8

Open
feenr opened this issue Feb 13, 2018 · 0 comments
Open

Add method summaries as java doc #8

feenr opened this issue Feb 13, 2018 · 0 comments

Comments

@feenr
Copy link
Member

feenr commented Feb 13, 2018

In a recent commit we enabled checkstyle as a build task. Most of the checkstyle issues were addressed, but validation requiring method summaries was disabled because there were 50-60 methods which needed to be documented.

As an easy task for someone looking to get familiar with this project, it would be nice to have method summaries and re-enabled the checkstyle configuration.

Expected Behavior

Public methods should have javadoc method summaries. Checkstyle validation should make sure this practice is carried forward.

Current Behavior

Most public methods in this project do not have documentation, and the validation is disabled in checkstyle configuration.

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

No branches or pull requests

1 participant