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

Add images used in Javadoc to src.zip

      Currently, having a JDK distribution on a local machine (with src.zip), tools like IDE can almost render Javadoc from it. The only missing part is images. For example, javax.swing.text.Document refers to images like src\java.desktop\share\classes\javax\swing\text\doc-files\plain11.gif, which are available in JDK source code and used to generate online docs. However, these images are absent in src.zip and in JDK distribution in general. As a result, tools either fail to generate the Javadoc locally, or need to grab an image from an Oracle website, using URLs like https://docs.oracle.com/en/java/javase/21/docs/api/java.desktop/javax/swing/text/doc-files/plain11.gif . This doesn't look nice, as the location of the images on the web is not specified, and nobody guarantees that they will be served under the same URL, not to mention that the internet connection might not be available. It would be great to include images used in Javadoc into src.zip, or any other file within JDK distribution, so third-party tools may find the images and render the Javadoc properly.

      Note that another external documentation resource, namely, snippet-files, are properly available inside src.zip (e.g. \jdk.jfr\jdk\jfr\snippet-files\Snippets.java), despite these files are not strictly the sources of JDK itself, so external snippets can be properly rendered (thank you for this!) It would be great to package images as well.

            Unassigned Unassigned
            tvaleev Tagir Valeev
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

              Created:
              Updated: