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

Remove support for `--no-module-directories`

    Details

    • Type: CSR
    • Status: Closed
    • Priority: P3
    • Resolution: Approved
    • Fix Version/s: 13
    • Component/s: tools
    • Labels:
      None
    • Subcomponent:
    • Compatibility Kind:
      behavioral
    • Compatibility Risk:
      low
    • Compatibility Risk Description:
      Hide
      Anyone relying on this option will need to change to using the new hierarchy.

      However, this is primarily only an issue for developers generating documentation for multiple modules at one time. It can affect the use of hand-written relative links between packages in different modules, using HTML <a href="../../some/other/package/SomeClass.java#someAnchor">. Such links will need to be updated to take the extra level of directory into account.
      Show
      Anyone relying on this option will need to change to using the new hierarchy. However, this is primarily only an issue for developers generating documentation for multiple modules at one time. It can affect the use of hand-written relative links between packages in different modules, using HTML <a href="../../some/other/package/SomeClass.java#someAnchor">. Such links will need to be updated to take the extra level of directory into account.
    • Interface Kind:
      add/remove/modify command line option, File or wire format
    • Scope:
      JDK

      Description

      Summary

      Remove support for the organizational hierarchy for module-oriented documentation as used in JDK 9 and JDK 10.

      Problem

      When javadoc added support for modules in JDK 9, it did not initially include an extra level of directory in the output hierarchy. That was addressed in JDK 11, along with an option to revert to the old layout in case of need. Maintaining support for the old layout is a maintenance burden and there is no use-case for supporting the old inferior layout.

      Solution

      Remove support for the old package-oriented hierarchy, and for the --no-module-directories option that enables it.

      Specification

      The --no-module-directories option is removed.

      The generated file hierarchy will always include a directory level for the module name.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                jjg Jonathan Gibbons
                Reporter:
                jjg Jonathan Gibbons
                Reviewed By:
                Priya Lakshmi Muthuswamy (Inactive)
              • Votes:
                0 Vote for this issue
                Watchers:
                2 Start watching this issue

                Dates

                • Created:
                  Updated:
                  Resolved: