Using @apiNote and other tags in JDK-specific APIs
mike.duigou at oracle.com
Wed Jul 16 20:49:36 UTC 2014
These tags certainly could be added to the other javadoc bundles. Initially I opted to only add them where essential.
One bit of weirdness you are probably wondering about--why is every tag named? The reason is that specifying an existing tag with -tag moves it to the end of the ordering. It's necessary to specify the total ordering if you don't want anything to change. The total ordering for tags was derived from the javadoc source code. (It is what it is).
On Jul 16 2014, at 13:24 , Alan Bateman <Alan.Bateman at oracle.com> wrote:
> I'm looking to use @apiNote, @implNote and a few other tags in JDK-specific APIs. The javadoc for these APIs is generated by make/Javadoc.gmk but I see that these -tag options are only used for build of the Java SE API docs. Should these tags be defined for the other javadoc commands too?
More information about the build-dev