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

Get per-symbol doc for enums

    XMLWordPrintableJSON

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Minor
    • Resolution: Unresolved
    • Affects Version/s: 1.7.4
    • Fix Version/s: None
    • Component/s: doc
    • Labels:
      None

      Description

      It would be nice to have the ability to add documentation for each symbol of an enum.

      Doug Cutting, quoted from the mailing list:

      Documentation per enum symbol is not currently supported, but would not be difficult to add. Please file an issue in Jira if you'd like to see this. For compatibility, in Json, this would probably appear as a parallel array of documentation strings, e.g., something like:

      ("name": "Foo", "type":"enum", "doc":"an enum", "symbols":["X","Y"], "symbols-doc":["X is X", "Y is Y"]}

        Attachments

          Activity

            People

            • Assignee:
              Unassigned
              Reporter:
              felixgv Felix GV
            • Votes:
              5 Vote for this issue
              Watchers:
              7 Start watching this issue

              Dates

              • Created:
                Updated: