What HTML attributes are allowed in Javadoc?

Question

I tried to use the lang attribute on an element in a documentation comment. Doclint (as part of the javadoc command) rejects that. I know I could suppress HTML errors in general, but I want to be told actual HTML errors.

This answer from 2015 lists allowed HTML tags, but I couldn’t even find a list of allowed attributes on tags.

Currently, for my specific problem, I added a custom taglet that transforms {@foreignterm de Hallo Welt} into <i lang="de">Hallo Welt</i>, but that’s not really close to optimal.

So I wonder how I could use <i lang="de">Hallo Welt</i> in a documentation comment. If it’s just not possible, which HTML attributes are allowed in Javadoc?

Michael · Accepted Answer · 2023-12-01 14:49:49Z

2

Not sure this is documented anywhere, but the source code is easy enough to understand:

e.g.

A(BlockType.INLINE, EndKind.REQUIRED,
        attrs(AttrKind.OK, HREF, TARGET, ID),
        attrs(AttrKind.HTML4, REV, CHARSET, SHAPE, COORDS, NAME))

The first argument (AttrKind) represents the validity. Possible values are: OK, INVALID, OBSOLETE, HTML4.

So for an anchor element, the 'href', 'target' and 'id' attributes are always okay. The 'rev', 'charset', etc. attributes are not supported in HTML5 (and you'll get this error)

Italic tags, like you tried to add an attribute to, do not accept any attributes.

 I(BlockType.INLINE, EndKind.REQUIRED,
     EnumSet.of(Flag.EXPECT_CONTENT, Flag.NO_NEST))

answered Dec 1, 2023 at 14:49

Michael

44.5k12 gold badges98 silver badges143 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

What HTML attributes are allowed in Javadoc?

1 Answer 1

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related