@apiNote, @implSpec and @implNote with Gradle

How-to build JavaDoc

In this post, I explain to you how you can build JavaDoc with the new tags @apiNote, @implSpec and @implNote with Gradle.

Prior to the new tags, the „JavaDoc“ always consisted of documentation about implementation and informative notes in a mixed way. With @apiNote, @implSpec and @implNote you can place different kinds of documentation into separate documentation sections. This way you could enhance the clarity and readability of your documentation.

I give you a brief overview:
API Notes. This category consists of commentary, rationale, or examples pertaining
to the API.
Implementation Specification. This is where the default implementation (or an overrideable implementation in a class) is specified.
Implementation Notes. This section contains informative notes about the implementation, such as advice or performance characteristics.

For further information, please refer to the JEP draft.

So, if you want to build JavaDoc with theses tags, you just have to add additional JavaDocOptions to the task.

build.gradle.kts Gist example

JEP draft: javadoc tags to distinguish API, implementation, specification, and notes

New Javadoc Tags @apiNote, @implSpec and @implNote