Skip to content

Documentation Comments Style Guide - Images in HTML Destination #19936

@gianmarcoschifone

Description

@gianmarcoschifone

Parent issue: #19807

Coverage table

Chapter link

Content

Image

Image

Text

Images in HTML Destination

  • Naming of doc images in HTML destination - Images would have the same name as they have in the source tree. Example:
    Button-1.gif
  • Location of doc images in HTML destination
    • With hierarchical file output, such as Javadoc 1.2, directories would be located in the package directory named "doc-files". For example: api/java/awt/doc-files/Button-1.gif
    • With flat file output, such as Javadoc 1.1, directories would be located in the package directory and named "images-". For example:
api/images-java.awt/
api/images-java.awt.swing/

Guidelines

These chapters do not appear to contain any implementable rule. Proposal:

Documentation Comments Rule Checkstyle Checks Used Sample files
Naming of doc images in HTML destination --
Location of doc images in HTML destination --

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions