[
https://issues.apache.org/jira/browse/AVRO-2080?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=16189222#comment-16189222
]
ASF GitHub Bot commented on AVRO-2080:
--------------------------------------
GitHub user Kuroshii opened a pull request:
https://github.com/apache/avro/pull/254
AVRO-2080: Fix Generated Record Javadocs
#### Changes:
- Add missing javadoc annotations to the specific record velocity template
- Update test files for specific compiler tool
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/Kuroshii/avro fix-generated-record-javadocs
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/avro/pull/254.patch
To close this pull request, make a commit to your master/trunk branch
with (at least) the following in the commit message:
This closes #254
----
commit a9872fd6e23821db6536a8d21a6271620ca5bd65
Author: Bridger Howell <howellbrid...@gmail.com>
Date: 2017-10-03T02:57:23Z
AVRO-2080: Add missing javadoc annotations to record template
commit 449d8b5e53ed4306edc5c45ce38019517ef9285e
Author: Bridger Howell <howellbrid...@gmail.com>
Date: 2017-10-03T02:57:30Z
AVRO-2080: Update SpecificCompilerTool test data
----
> 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
> Attachments: Test.java
>
>
> 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)
