blagerweij / liquibase-sessionlock

Session-level lock support for Liquibase
Apache License 2.0
118 stars 23 forks source link

Replace usage of `@see "<a href>...</a> ..."` javadoc hack #26

Closed stanio closed 1 year ago

stanio commented 1 year ago

If you build using a newer Gradle version supporting Java 17+:

gradle javadoc

you may notice (build/docs/javadoc/) the content of @see "<a href>...</a> ..." references is rendered as literal text:

"\Locking Functions (MySQL 8.0 Reference Manual)"

vs. raw HTML markup:

"Locking Functions (MySQL 8.0 Reference Manual)"

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: