avro-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Charles Gariépy-Ikeson (JIRA) <j...@apache.org>
Subject [jira] [Commented] (AVRO-1681) Improve generated JavaDocs
Date Thu, 25 Jun 2015 20:17:05 GMT

    [ https://issues.apache.org/jira/browse/AVRO-1681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14601854#comment-14601854

Charles Gariépy-Ikeson commented on AVRO-1681:

I've uploaded a separate patch for trunk. It is somewhat bigger as adjusting the comment generation
caused a handful of unit tests to fail that didn't exist in the 1.7 branch.


> 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
>            Priority: Minor
>             Fix For: 1.7.8
>         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

View raw message