Bridger Howell created AVRO-2080:
------------------------------------
Summary: Fix Javadoc Warnings in Generated Records
Key: AVRO-2080
URL: https://issues.apache.org/jira/browse/AVRO-2080
Project: Avro
Issue Type: Bug
Components: java
Affects Versions: 1.8.2
Reporter: Bridger Howell
Priority: Minor
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:
{noformat}
{
"type":"record",
"name":"Test",
"namespace":"foo.bar",
"fields":[
{"name":"name","type":"string"}
],
"version":1
}
{noformat}
And then run the javadoc tool on it, I get the following javadoc warnings:
{noformat}
[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] ^
{noformat}
Since this is a simple enough problem, I'll see if I can make a quick patch in
a bit.
--
This message was sent by Atlassian JIRA
(v6.4.14#64029)
