Uploaded image for project: 'Apache Avro'
  1. Apache Avro
  2. AVRO-1681

Improve generated JavaDocs

    XMLWordPrintableJSON

    Details

    • 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
    • Labels:
      None
    • Hadoop Flags:
      Reviewed

      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.

        Attachments

        1. AVRO-1681-TRUNK.patch
          26 kB
          Charles Gariépy-Ikeson
        2. AVRO-1681.patch
          10 kB
          Charles Gariépy-Ikeson

          Issue Links

            Activity

              People

              • Assignee:
                cikeson Charles Gariépy-Ikeson
                Reporter:
                cikeson Charles Gariépy-Ikeson
              • Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: