The warnings about the unknown references seem to be caused by using the @value tag to reference the value of a private constant. In my experience, they only appear on JDK 8 and not 11+. I consider this usage worth the warning since it ensures that the value given in the docs actually matches what's in the code.
Regards, Matt J On Thu, Aug 19, 2021 at 9:51 AM Gilles Sadowski <[email protected]> wrote: > > Le jeu. 19 août 2021 à 15:15, Alex Herbert <[email protected]> a écrit > : > > > > On Thu, 19 Aug 2021 at 14:00, Gilles Sadowski <[email protected]> wrote: > > > > > SNIP > > > * Build OK (using Java 8). But Javadoc warnings (cf. previous message > > > about RC3) are still present (not sure whether that should have been > > > fixed).[1] > > > > > > > Q. Which maven command do you use to see these warnings? > > $ JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/ mvn package javadoc:javadoc > > Excerpt of output: > ---CUT--- > [...] > 11 warnings > [WARNING] Javadoc Warnings > [WARNING] > /home/gilles/devel/java/apache/release_check/commons-geometry-1.0-rc4/commons-geometry-io-euclidean/src/main/java/org/apache/commons/geometry/io/euclidean/threed/obj/ObjBoundaryWriteHandler3D.java:82: > warning - #DEFAULT_LINE_SEPARATOR (referenced by @value tag) is an > unknown reference. > [WARNING] > /home/gilles/devel/java/apache/release_check/commons-geometry-1.0-rc4/commons-geometry-io-euclidean/src/main/java/org/apache/commons/geometry/io/euclidean/threed/obj/ObjBoundaryWriteHandler3D.java:114: > warning - #DEFAULT_MESH_BUFFER_BATCH_SIZE (referenced by @value tag) > is an unknown reference. > [WARNING] > /home/gilles/devel/java/apache/release_check/commons-geometry-1.0-rc4/commons-geometry-io-euclidean/src/main/java/org/apache/commons/geometry/io/euclidean/threed/obj/ObjBoundaryWriteHandler3D.java:124: > warning - #DEFAULT_MESH_BUFFER_BATCH_SIZE (referenced by @value tag) > is an unknown reference. > [...] > ---CUT--- > > > Using JDK 8 or 11 and 'mvn javadoc:javadoc' or 'mvn site' I do not see any > > warnings. > > $ JAVA_HOME=/usr/lib/jvm/java-8-openjdk-amd64/ mvn --version > Apache Maven 3.6.0 > Maven home: /usr/share/maven > Java version: 1.8.0_292, vendor: Oracle Corporation, runtime: > /usr/lib/jvm/java-8-openjdk-amd64/jre > Default locale: en_US, platform encoding: UTF-8 > OS name: "linux", version: "4.19.0-16-amd64", arch: "amd64", family: "unix" > > $ /usr/lib/jvm/java-8-openjdk-amd64/bin/java -version > openjdk version "1.8.0_292" > OpenJDK Runtime Environment (build 1.8.0_292-8u292-b10-0+deb9u1-b10) > OpenJDK 64-Bit Server VM (build 25.292-b10, mixed mode) > > > > > I've only tried one platform and this may be JDK and/or platform specific. > > I'd like to know as the warnings are helpful to correct documentation > > issues. > > Using Java 11: > > $ JAVA_HOME=/usr/lib/jvm/java-11-openjdk-amd64/ mvn package javadoc:javadoc > > Excerpt: > ---CUT--- > [...] > 6 warnings > [WARNING] Javadoc Warnings > [WARNING] > /home/gilles/devel/java/apache/release_check/commons-geometry-1.0-rc4/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/ReverseRay.java:181: > warning - @inheritDoc used but splitOnIntersection(Line, Vector2D) > does not override or implement any method. > [WARNING] > /home/gilles/devel/java/apache/release_check/commons-geometry-1.0-rc4/commons-geometry-euclidean/src/main/java/org/apache/commons/geometry/euclidean/twod/ReverseRay.java:181: > warning - @inheritDoc used but splitOnIntersection(Line, Vector2D) > does not override or implement any method. > [...] > ---CUT--- > > But the other warnings (about "unknown reference") are gone; so indeed, is > this a newer Javadoc feature? > > Thanks, > Gilles > > > > > Alex > > --------------------------------------------------------------------- > To unsubscribe, e-mail: [email protected] > For additional commands, e-mail: [email protected] > --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
