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

Eliminate javadoc warnings #27

Closed
simondelabici opened this issue Jun 19, 2018 · 0 comments
Closed

Eliminate javadoc warnings #27

simondelabici opened this issue Jun 19, 2018 · 0 comments

Comments

@simondelabici
Copy link
Contributor

Get rid of all javadoc warnings .

Note: the goal here is to stop the stream of (over 100) ugly warning messages that get emitted when building the project. Writing good javadoc takes time and is hard. This issue does not seek to address that, but purely to improve things to the point where the build proceeds quietly. This will be accomplished by making small tweaks to the code. Unfortunately without a deep understanding of the underlying implementation it may sometimes be necessary to do things like this:

@param myThingy the thingy of mine.

One can argue that this is meaningless ! In time it is hoped that we can improve the Javadoc so that it provides something meaningful.

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