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

Cleanup/simplify HTML/CSS for general block tags

    XMLWordPrintable

Details

    Description

      block tags in javadoc comments are currently translated to a definition list.

      All tags have a mostly-superfluous <span> in the <dt> node, which has a class attribute that could be moved to the enclosing <dt>. That being said, 4 tags (@param, @return, @see, @throws) get their own class attribute value, whereas all other block tags get to share the same attribute value. Even so, they all resolve to the same style in the stylesheet.

      It would be simpler to put a class, such as "blockTags", on the enclosing <dt> node, and to drop the <span> and class attribute from the label. Admittedly, it would not be possible to use tag-specific styles for the presentation of different tags, but that can't be done on the values anyway. If this was really wanted, we could generate and use a class based on the tag name, and put the class on both the <dt> and corresponding <dd> nodes.

      Attachments

        Issue Links

          Activity

            People

              jjg Jonathan Gibbons
              jjg Jonathan Gibbons
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved: