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

Fix and enforce javadoc issues #699

Open
ctron opened this issue Jun 27, 2017 · 2 comments
Open

Fix and enforce javadoc issues #699

ctron opened this issue Jun 27, 2017 · 2 comments
Labels
build Documentation Doc... What?? Joke! We will write some!

Comments

@ctron
Copy link
Contributor

ctron commented Jun 27, 2017

Currently the build is full or warnings like this:

[WARNING] * @throws KapuaException
[WARNING] ^
[WARNING] /home/travis/build/ctron/kapua/service/security/authorization/api/src/main/java/org/eclipse/kapua/service/authorization/role/RolePermissionService.java:98: warning: no description for @throws
[WARNING] * @throws KapuaException
[WARNING] ^
[WARNING] /home/travis/build/ctron/kapua/service/security/authorization/api/src/main/java/org/eclipse/kapua/service/authorization/role/RolePermissionXmlRegistry.java:27: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/travis/build/ctron/kapua/service/security/authorization/api/src/main/java/org/eclipse/kapua/service/authorization/role/RolePermissionXmlRegistry.java:36: warning: no description for @return
[WARNING] * @return
[WARNING] ^
[WARNING] /home/travis/build/ctron/kapua/service/security/authorization/api/src/main/java/org/eclipse/kapua/service/authorization/role/RolePermissionXmlRegistry.java:45: warning: no description for @return
[WARNING] * @return

I would suggest to 1) fix existing issues by dropping empty javadoc fragments and find a way to enforce that no empty javadoc fragments get added in the future.

If we have actual javadoc that is fine, but empty javadoc snippets and warnings in the build should be fixed IMHO.

@ctron ctron added the build label Jun 27, 2017
@ctron ctron added this to the 0.3.0 milestone Jun 27, 2017
@ctron
Copy link
Contributor Author

ctron commented Jun 27, 2017

This would also fix issues with Travis and "too long" console output

@Coduz Coduz removed this from the 0.3.0 milestone May 4, 2020
@Coduz Coduz added the Documentation Doc... What?? Joke! We will write some! label May 4, 2020
@Coduz
Copy link
Contributor

Coduz commented May 4, 2020

We are slowly add javadoc as we add new stuff and fix bugs.
So we move this issue on to the next release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build Documentation Doc... What?? Joke! We will write some!
Projects
None yet
Development

No branches or pull requests

2 participants