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

Comments on profiles support in javadoc

    XMLWordPrintable

    Details

      Description


      This bug tracks issues to examine in the javadoc support for profiles once it reaches jdk8. At this time, the javadoc changes are in the profiles-staging forest awaiting PIT. They are not expected to be pushed to jdk8 master until Feb 20.

      Issues:

      1. The default view is "All Profiles", I think it should be "All Packages". The reason is that 99% of developers will not be targeting runtimes that implement Profiles of Java SE and so they shouldn't need to care about the All Profiles view.

      2. There is a package-summary per profile that only lists one profile name at the top. This can be confusing when selecting a profile as it gives the impression that a package is only in one profile. For example, if I select "compact2" and java.io then the package description gives the impression to the reader that this package is only in compact2 whereas it is in all profiles.

      3. The overview-summary.html has a new Profiles section but looks a bit odd to have a Description column when there isn't any description.

        Attachments

          Issue Links

            Activity

              People

              Assignee:
              bpatel Bhavesh Patel (Inactive)
              Reporter:
              alanb Alan Bateman
              Votes:
              0 Vote for this issue
              Watchers:
              7 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: