[AVRO-2080] Fix Javadoc Warnings in Generated Records

• Type: Bug
• Status: Resolved
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.8.2
• Fix Version/s: 1.9.0
• Component/s: java
• Assignee: Bridger Howell
• Reporter: Bridger Howell
• Created: 20/Sep/17 13:46
• Updated: 24/Oct/19 08:26
• Resolved: 13/Dec/17 09:55

Description

I've been seeing a number of javadoc errors for the generated records using the 1.8.2 version of SpecificCompiler.

For example, if I generate code from the following schema:

{
    "type":"record",
    "name":"Test",
    "namespace":"foo.bar",
    "fields":[
        {"name":"name","type":"string"}
     ],
    "version":1
}

And then run the javadoc tool on it, I get the following javadoc warnings:

[warn] src_managed/main/Test.java:30: warning: no @return
[warn]   public static BinaryMessageDecoder<Test> getDecoder() {
[warn]                                            ^
[warn] src_managed/main/Test.java:38: warning: no @return
[warn]   public static BinaryMessageDecoder<Test> createDecoder(SchemaStore resolver) {
[warn]                                            ^
[warn] src_managed/main/Test.java:43: warning: no @return
[warn]   public java.nio.ByteBuffer toByteBuffer() throws java.io.IOException {
[warn]                              ^
[warn] src_managed/main/Test.java:43: warning: no @throws for java.io.IOException
[warn]   public java.nio.ByteBuffer toByteBuffer() throws java.io.IOException {
[warn]                              ^
[warn] src_managed/main/Test.java:48: warning: no @param for b
[warn]   public static Test fromByteBuffer(
[warn]                      ^
[warn] src_managed/main/Test.java:48: warning: no @return
[warn]   public static Test fromByteBuffer(
[warn]                      ^
[warn] src_managed/main/Test.java:48: warning: no @throws for java.io.IOException
[warn]   public static Test fromByteBuffer(
[warn]                      ^

Since this is a simple enough problem, I'll see if I can make a quick patch in a bit.

Issue Links

• links to: GitHub Pull Request #254