Uploaded image for project: 'mdsal'
  1. mdsal
  2. MDSAL-755

Improve javadoc of generated classes

    XMLWordPrintable

Details

    • Improvement
    • Status: Resolved
    • Medium
    • Resolution: Done
    • None
    • 10.0.0
    • Binding codegen
    • None

    Description

      JDK17's javadoc has a number of new linters and is generally less happy about undocumented elements and notably about default constructors.

      Improve code generator to include more expansive documentation of elements, so that the number of warnings is at a reasonable level.

      Attachments

        Issue Links

          split to

          Improvement - An improvement or enhancement to an existing feature or task. MDSAL-758 Generate javadocs for Builder.withKey()

          • Medium - Has the potential to affect progress.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. MDSAL-759 Improve javadoc for generated keys

          • Medium - Has the potential to affect progress.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. MDSAL-760 Generate javadoc for unions

          • Medium - Has the potential to affect progress.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. MDSAL-761 Generate javadoc for augments

          • Medium - Has the potential to affect progress.
          • Resolved

          Improvement - An improvement or enhancement to an existing feature or task. MDSAL-762 Generate javadoc for ScalarTypes

          • Medium - Has the potential to affect progress.
          • Resolved
          No reviews matched the request. Check your Options in the drop-down menu of this sections header.

          Activity

            People

              rovarga Robert Varga
              rovarga Robert Varga
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: