RFR: JDK-8203366 tag added wrongly in Docs.gmk

Magnus Ihse Bursie magnus.ihse.bursie at oracle.com
Thu May 24 12:32:45 UTC 2018


 From the bug report:

This line in Docs.gmk is incorrect, and should be removed.

-tag version \

It incorrectly enables support for the @version tag, which should only 
be enabled by the (poorly-named) -version option.  (@version and 
-version are a similar pair to @author and -author).

A small number of java SE API files contain a very-old @version tag, and 
this started showing up in JavaSE docs in JDK 8. You can find these 
files by grepping recursively for @version.  The change that added this 
line is probably a side-effect of adding support for the @apiNote, 
@implNote, @implSpec tags.

Note that removing this line will change the Java SE API docs, reverting 
the handling of @version back to its original treatment of being ignored 
up through and including JDK 7.

Bug: https://bugs.openjdk.java.net/browse/JDK-8203366
Patch inline:
diff --git a/make/Docs.gmk b/make/Docs.gmk
--- a/make/Docs.gmk
+++ b/make/Docs.gmk
@@ -85,7 +85,6 @@
      -tag throws \
      -taglet build.tools.taglet.ModuleGraph \
      -tag since \
-    -tag version \
      -tag serialData \
      -tag factory \
      -tag see \

/Magnus



More information about the build-dev mailing list