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 JDoc comments #141

Open
norling opened this issue May 14, 2019 · 1 comment
Open

Add JDoc comments #141

norling opened this issue May 14, 2019 · 1 comment
Assignees
Labels

Comments

@norling
Copy link
Collaborator

norling commented May 14, 2019

Description

The Java code should have JDoc comments according to the google styleguide rules at https://google.github.io/styleguide/javaguide.html#s7-javadoc.

Proposed solution

Write JDoc where missing, and keep it updated for all future changes to the code.

Definition of Done

Javadoc is present for every public class, and every public or protected member of such a class.

@norling norling self-assigned this May 14, 2019
@juhtornr juhtornr changed the title JDoc Add JDoc comments May 16, 2019
@juhtornr
Copy link
Collaborator

Martin will make a PR when DataEdge part is done and then someone else can take a look and provide feedback.

@norling norling mentioned this issue Jun 14, 2019
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants