I remember using this hack previously for the purpose of including cite HTML markup (providing extra context where the original link was found):
@see "<a href>...</a> <cite>...</cite>"
because cite is not recognized by javadoc (JDK-4907024). Since then I've also dropped the usage of cite, and that could be replaced by a generic typography markup – i (italics):
@see <a href>...</a> <i>...</i>
See also:
@see, Documentation Comment Specification for the Standard Doclet (JDK 17)
If you build using a newer Gradle version supporting Java 17+:
you may notice (
build/docs/javadoc/
) the content of@see "<a href>...</a> ..."
references is rendered as literal text:vs. raw HTML markup:
I remember using this hack previously for the purpose of including
cite
HTML markup (providing extra context where the original link was found):because
cite
is not recognized by javadoc (JDK-4907024). Since then I've also dropped the usage ofcite
, and that could be replaced by a generic typography markup –i
(italics):See also: