[
https://issues.apache.org/jira/browse/AVRO-1681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14603054#comment-14603054
]
Hudson commented on AVRO-1681:
------------------------------
SUCCESS: Integrated in AvroJava #521 (See
[https://builds.apache.org/job/AvroJava/521/])
AVRO-1681. Improve generated JavaDocs. Contributed by Charles Gariépy-Ikeson.
(tomwhite: rev 1687778)
* /avro/trunk/CHANGES.txt
* /avro/trunk/lang/java/avro/src/main/java/org/apache/avro/Protocol.java
*
/avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/fixed.vm
*
/avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/protocol.vm
*
/avro/trunk/lang/java/compiler/src/main/velocity/org/apache/avro/compiler/specific/templates/java/classic/record.vm
*
/avro/trunk/lang/java/ipc/src/test/java/org/apache/avro/compiler/specific/TestSpecificCompiler.java
*
/avro/trunk/lang/java/tools/src/test/compiler/output-string/avro/examples/baseball/Player.java
* /avro/trunk/lang/java/tools/src/test/compiler/output/Player.java
> Improve generated JavaDocs
> --------------------------
>
> Key: AVRO-1681
> URL: https://issues.apache.org/jira/browse/AVRO-1681
> Project: Avro
> Issue Type: Improvement
> Components: java
> Affects Versions: 1.7.7
> Reporter: Charles Gariépy-Ikeson
> Assignee: Charles Gariépy-Ikeson
> Priority: Minor
> Fix For: 1.7.8, 1.8.0
>
> Attachments: AVRO-1681-TRUNK.patch, AVRO-1681.patch
>
>
> Hi everyone!
> I've noticed that the JavaDocs generated by the SpecificCompiler could use a
> little TLC. Our usage of Avro includes the IPC component, and it would be
> nice if the JavaDocs that were generated from our avpr files were a little
> more verbose, especially when working with IDEs that integrate JavaDocs from
> the classes we are using. It would help usage of the interfaces and classes
> generated from the protocol file, without having to dive deeper into the
> class or protocol file from which it was generated.
> I've made a first attempt at accomplishing this. This is my first patch, so
> don't hesitate to point out something I've missed or needs improving.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
