You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@avro.apache.org by "ASF subversion and git services (JIRA)" <ji...@apache.org> on 2017/01/28 05:51:25 UTC
[jira] [Commented] (AVRO-1681) Improve generated JavaDocs
[ https://issues.apache.org/jira/browse/AVRO-1681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=15843895#comment-15843895 ]
ASF subversion and git services commented on AVRO-1681:
-------------------------------------------------------
Commit 49f3bf03df80c74c82416618639efbc81f81b7a0 in avro's branch refs/heads/branch-1.7 from [~radai]
[ https://git-wip-us.apache.org/repos/asf?p=avro.git;h=49f3bf0 ]
AVRO-1988 Make 1.7 branch actually build. Contributed by Radai Rosenblatt.
Seems like AVRO-1681 was only partially applied to the 1.7 branch. Specifically, the expected test output was not updated to reflect changes in javadoc.
This commit fixes the tests and makes the build pass
Also ignores IDEA files.
Closes #139.
Signed-off-by: Suraj Acharya <su...@gmail.com>
Signed-off-by: Sean Busbey <bu...@apache.org>
> 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.patch, AVRO-1681-TRUNK.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)