This is good to know. Thanks for looking into this, Alex!
-Matt

On Thu, Aug 19, 2021 at 1:45 PM Alex Herbert <alex.d.herb...@gmail.com> wrote:
>
> It is definitely platform dependent. JDK 11.0.12 on my MacOS did not show
> warnings. JDK 11.0.11 on my linux workstation did show warnings in the
> euclidean module.
>
> Java. Build once, run anywhere, but with variations.
>
> These are not warnings about private @value tags. These are
> incorrect @inheritDoc:
>
> 6 warnings
> [WARNING] Javadoc Warnings
> [WARNING]
> /tmp/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]
> /tmp/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]
> /tmp/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]
> /tmp/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]
> /tmp/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]
> /tmp/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.
>
> I do not see warnings in other modules.
>
> These are the same warnings that Gilles reported. But on closer inspection
> it is the same warning 6 times. The line in question in ReverseRay does
> correctly override a method. So this is a bug in the javadoc tool on the
> linux platform. This explains why I did not see it on another build env.
> Because it is not a javadoc issue but an issue with the javadoc tool.
>
> If I run this with JDK 8 (1.8.0_241) on the same linux machine then I do
> not see the warnings in this or any other module.
>
> Alex
>
>
> On Thu, 19 Aug 2021 at 15:34, Matt Juntunen <matt.a.juntu...@gmail.com>
> wrote:
>
> > 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
> >

---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscr...@commons.apache.org
For additional commands, e-mail: dev-h...@commons.apache.org

Reply via email to