Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
[AVRO-2145] Cannot create Javadoc on JDK8+ #334
From Java 8 on the JavaDoc is being linted and it will fail early if there are issues with the JavaDoc: http://openjdk.java.net/jeps/172
This patch will add the missing Javadoc with some stubs. Additionally I updated the docs of some of the public API by hand to make the Javadoc more verbose.
The JavaDoc needs to be updated in the future, but this commit will let the compiler pass the javadoc check step.
Tested locally and it passes the tests. This patch only changes the Javadoc and does not change the logic of the code.
I'm not fond of whitespace changes. Are all of these really required to pass JavaDoc lint? In particular, a lot of existing Javadoc comments have content on the first line. When these are moved to a new line it causes the rest of the comment to be re-indented. I'd prefer we don't make that style change here.