Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8313204

Inconsistent order of sections in generated class documentation

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • P4
    • 22
    • 22
    • tools
    • None

    Description

      Two inconsistencies have been observed in the generated output.

      1. annotation types

      For an annotation type that defines fields as well as annotation members:
      the field summary appears after the annotation members summaries
      the field details appear before the annotation members details
      so the page is ordered:
         Optional Element Summary
         Field Summary
         Field Details
         Element Details

      2. Classes with JavaFX-style properties

      The existing order, for classes that have them, is
          Properties
          Nested Classes
          Fields

      In general, the order of elements on a page is
         nested classes
         field-like members
         method-like members

      --

      This suggests that nested classes should appear before properties, and that the same general order should apply to both summary tables and detail lists.

      Attachments

        Issue Links

          Activity

            People

              jjg Jonathan Gibbons
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: