The javadoc should contain a note about usages of requires transitive java.base;

XMLWordPrintable

    • Type: CSR
    • Resolution: Approved
    • Priority: P3
    • 24
    • Component/s: tools
    • None
    • behavioral
    • minimal
    • Language construct
    • JDK

      Summary

      Uses of requires transitive java.base; (which is a preview feature under JEP 494) will get a warning box in the javadoc output.

      Problem

      Uses of requires transitive java.base;, as a preview feature, are not marked in the javadoc in any way.

      Solution

      When a module, JDK or user, will declare requires transitive java.base;, they will get a warning box in the javadoc output.

      Specification

      Sample javadoc output is uploaded as 8343752-v2.zip containing:

      • 8343752/original/api/java.se/module-summary.html: is the module summary for java.se before this change, also available for convenience here: https://cr.openjdk.org/~jlahoda/8343752/original/api/java.se/module-summary.html
      • 8343752/updated/api/java.se/module-summary.html: is the module summary for java.se after this change, also available for convenience here: https://cr.openjdk.org/~jlahoda/8343752/updated/api/java.se/module-summary.html
      • 8343752/user.module contains the javadoc for a custom module using the feature, also available for convenience here: https://cr.openjdk.org/~jlahoda/8343752/user.module/test.module/module-summary.html

        1. 8343752.zip
          13.32 MB
        2. 8343752-v2.zip
          13.32 MB

            Assignee:
            Jan Lahoda
            Reporter:
            Jan Lahoda
            Adam Sotona
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Created:
              Updated:
              Resolved: