Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Naming of doc images in source tree
Name GIF images -1.gif, incrementing the integer for subsequent images in the same class. Example:
Button-1.gif
Guidelines
No existing check enforces naming conventions for documentation images referenced in Javadoc comments.
🔴 We do not plan to implement this rule at the moment.
The rule requires sequential numeric image names, for example Button-1.gif, Button-2.gif, and so on. This is problematic because adding a new image before existing ones would require renaming all following image files and updating all related references in the documentation.
Descriptive image names are usually preferred today. Numeric indexing was mainly useful when file systems had strong filename length limits.
We can still accept a PR for this rule if someone needs it.
| Documentation Comments Rule |
Checkstyle Checks Used |
Sample files |
| Naming of doc images in source tree |
🚫 Not implemented. Sequential numeric image names are not recommended because they create unnecessary renaming and reference updates when images are inserted before existing ones. A PR can still be accepted if someone needs this validation. |
|
Parent issue: #19807
Coverage table
Chapter link
Content
Image
Text
Naming of doc images in source tree
Name GIF images -1.gif, incrementing the integer for subsequent images in the same class. Example:
Button-1.gif
Guidelines
No existing check enforces naming conventions for documentation images referenced in Javadoc comments.
🔴 We do not plan to implement this rule at the moment.
The rule requires sequential numeric image names, for example
Button-1.gif,Button-2.gif, and so on. This is problematic because adding a new image before existing ones would require renaming all following image files and updating all related references in the documentation.Descriptive image names are usually preferred today. Numeric indexing was mainly useful when file systems had strong filename length limits.
We can still accept a PR for this rule if someone needs it.