[jira] [Updated] (AVRO-1681) Improve generated JavaDocs

2015-06-10 Thread JIRA

 [ 
https://issues.apache.org/jira/browse/AVRO-1681?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
 ]

Charles Gariépy-Ikeson updated AVRO-1681:
-
Attachment: AVRO-1681.patch

 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.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)


[jira] [Commented] (AVRO-1681) Improve generated JavaDocs

2015-06-10 Thread JIRA

[ 
https://issues.apache.org/jira/browse/AVRO-1681?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14581237#comment-14581237
 ] 

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

I've added AVRO-1681.patch. Please review for submission.

Thanks!

 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.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)


[jira] [Created] (AVRO-1681) Improve generated JavaDocs

2015-06-10 Thread JIRA
Charles Gariépy-Ikeson created AVRO-1681:


 Summary: 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


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)