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)

Reply via email to