Details

    • Type: Sub-task
    • Status: Resolved
    • Priority: P4
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 14
    • Component/s: tools
    • Labels:

      Description

      For records:
          use correct "keyword" for type declaration
          `@param` on class (to document components)
          generation of Javadoc for mandated members: constructor, accessors, equals, hashCode etc also private field (for when `-private` is used)
              allow for user overrides
              ensure mandated members are indexed

      For sealed types:
          generate `sealed` and `non-sealed` as appropriate
          generating “permitted subtypes” section

      For all types:
          if the supertype is sealed, and this type is unsealed, show `non-sealed`

      For both:
          update the Class-Use pages
          update doclint to check @param on record types

      Test cases:
          for sealed types, ensure implicit permitted subtypes are handled correctly (i.e. in a timely manner for javadoc)
          good @params,
          bad @params: missing, wrong name, duplicate names
          explicitly-defined accessor methods for components and default constructor
          {@inheritDoc} in explicitly-defined accessor methods for components and default constructor

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              jjg Jonathan Gibbons
              Reporter:
              vromero Vicente Arturo Romero Zaldivar
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: