Allowed HTML tags in Javadoc -
the checkstyle rule javadocstyle not allow tag <u>. according docs, checks patterned after checks made doccheck doclet available sun. unfortunately, have not found doccheck anywhere. neither have found official documentation allowed html tags in javadoc. there any?
javadoc permits subset of html tags, of java 8.
javadoc's doclint component enforces restriction. can disable doclint warnings passing -xdoclint:none javadoc, though should consider fixing javadoc comments because otherwise generated html api documentation may bad or may omit content. (i use -xdoclint:all,-missing warnings except missing javadoc @ tags.)
i have not found public documentation of tags doclint permits, here list of allowed html tags, gleaned java 8's file langtools/src/share/classes/com/sun/tools/doclint/htmltag.java.
a b big blockquote body br caption center cite code dd dfn div dl dt em font frame frameset h1 h2 h3 h4 h5 h6 head hr html img li link menu meta noframes noscript ol p pre script small span strong sub sup table tbody td tfoot th thead title tr tt u ul var update jdk 9
jdk 9 permits different set of tags jdk 8 does. here list of tags both jdks, notes permitted 1 of jdks. again, data comes htmltag.java file.
a big // jdk 8 b // jdk 8 blockquote body br caption center cite // jdk 8 code dd dfn // jdk 8 dir // jdk 9 div dl dt em font footer // jdk 9 frame // jdk 8 frameset // jdk 8 h1 h2 h3 h4 h5 h6 head header // jdk 9 hr html iframe // jdk 9 img input // jdk 9 li link listing // jdk 9 main // jdk 9 menu meta nav // jdk 9 noframes // jdk 8 noscript ol p pre script section // jdk 9 small span strong sub sup // jdk 8 table tbody td tfoot // jdk 8 th thead // jdk 8 title tr tt u // jdk 8 ul var // jdk 8
Comments
Post a Comment