Parent issue: #19807

Coverage table

Chapter link

Content

Image

Text

Location of doc images in source tree

Put doc images in a directory called "doc-files". This directory should reside in the same package directory where the source files reside. (The name "doc-files" distinguishes it as documentation separate from images used by the source code itself, such as bitmaps displayed in the GUI.) Example: A screen shot of a button, Button-1.gif, might be included in the class comment for the Button class. The Button source file and the image would be located at:
java/awt/Button.java (source file)

java/awt/doc-files/Button-1.gif (image file)

Guidelines

No existing check verifies that images referenced from Javadoc comments are located under a doc-files directory in the corresponding package.

This is stronger than a pure style guideline: with the standard Javadoc behavior, files outside doc-files are not copied automatically to the generated documentation, so such image references may be broken unless the build copies them separately.