Uploaded image for project: 'JDK'
  1. JDK
  2. JDK-8167227 JEP 299: Reorganize Documentation
  3. JDK-8172312

Update docs target and image for new combined docs

    XMLWordPrintable

Details

    • b167

    Backports

      Description

        We should create a new target in the build to create a new/different docs image, containing a simple composite javadoc bundle, containing all the JDK API documentation. This will provide better links between related types that may currently appear in different javadoc bundles.

        Generally speaking, the new composite bundle should be based o a list of modules (using the new javadoc --modules <module-list> option) instead of a list of packages, where the list of modules is roughly
           all java.* modules
           all jdk.* modules except any jdk.internal.* modules
           any appropriate "imported modules" (e.g. such as javafx.*)

        Attachments

          Issue Links

            backported by

            Backport - A issue that is required to port a Bug or Feature into another product release. This issue type is generally associated with the main Bug/Feature to represent each individual release of the port. JDK-8179711 Update docs target and image for new combined docs

            • P3 - Major loss of function.
            • Resolved
            blocks

            Bug - A problem which impairs or prevents the functions of the product. JDK-8178037 Move information from jdi-overview.html into jdk.jdi module-info.java

            • P3 - Major loss of function.
            • Resolved

            Bug - A problem which impairs or prevents the functions of the product. JDK-8178038 Copy jdwp-protocol.html to proper location

            • P3 - Major loss of function.
            • Resolved

            Bug - A problem which impairs or prevents the functions of the product. JDK-8178316 Add JVM-MANAGEMENT-MIB.mib to jdk/src/java.management/share/specs/

            • P3 - Major loss of function.
            • Resolved

            Enhancement - null JDK-8176785 Add build support to generate PNG file from .dot file

            • P3 - Major loss of function.
            • Resolved
            duplicates

            Enhancement - null JDK-8091039 Create combined JDK / FX API docs bundle

            • P3 - Major loss of function.
            • Closed
            relates to

            Sub-task - The sub-task of the issue JDK-8175036 All API docs should be built for HTML 5

            • P3 - Major loss of function.
            • Resolved

            Sub-task - The sub-task of the issue JDK-8177434 Copy specifications from module specs directory to docs image

            • P3 - Major loss of function.
            • Resolved

            Bug - A problem which impairs or prevents the functions of the product. JDK-8175824 Adapt javadoc generation to different requirements for JDK and JavaSE

            • P3 - Major loss of function.
            • Resolved

            Enhancement - null JDK-8091039 Create combined JDK / FX API docs bundle

            • P3 - Major loss of function.
            • Closed

            Activity

              People

                ihse Magnus Ihse Bursie
                jjg Jonathan Gibbons
                Votes:
                0 Vote for this issue
                Watchers:
                5 Start watching this issue

                Dates

                  Created:
                  Updated:
                  Resolved: