[AVRO-1681] Improve generated JavaDocs

• Type: Improvement
• Status: Closed
• Priority: Minor
• Resolution: Fixed
• Affects Version/s: 1.7.7
• Fix Version/s: 1.8.0, 1.9.0
• Component/s: java
• Hadoop Flags: Reviewed
• Assignee: Charles Gariépy-Ikeson
• Reporter: Charles Gariépy-Ikeson
• Created: 10/Jun/15 23:29
• Updated: 24/Oct/19 08:25
• Resolved: 26/Jun/15 14:42

Description

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.

Issue Links

• links to: GitHub Pull Request #139