Javadoc:

The Javadoc for classes that rely on public components from Commons-Numbers
do not link to the Common Numbers javadoc, e.g.

https://home.apache.org/~mattjuntunen/commons-geometry-1.0-RC3-site/commons-geometry-euclidean/apidocs/org/apache/commons/geometry/euclidean/threed/rotation/QuaternionRotation.html#of(org.apache.commons.numbers.quaternion.Quaternion)

You can configure the javadoc plugin with a list of additional sites where
it can find javadoc for other packages. So you should be able to link the
javadoc in Geometry to the relevant javadoc in Numbers.


Checkstyle:

You have some checkstyle configuration in the source code, e.g. Point2S:

    // CHECKSTYLE: stop ConstantName
    /** A point with all coordinates set to NaN. */
    public static final Point2S NaN = new Point2S(Double.NaN, Double.NaN,
null);
    // CHECKSTYLE: resume ConstantName

Typically these should be moved to the checkstyle exclusions XML file to
keep the main source clean. However I think it is always to allow the use
of NaN for a constant. So you can configure the checkstyle rule to allow
this with a regex:

https://checkstyle.sourceforge.io/config_naming.html#ConstantName

    <module name="ConstantName">
      <property name="format" value="^NaN$|^[A-Z][A-Z0-9]*(_[A-Z0-9]+)*$"/>
    </module>

I found that the ConstantName module is duplicated in the checkstyle config
so you have to add the format property to the first instance (and remove
the second instance).


User guide:

This is a very well written guide to help understand the layout and
function of the library. A minor improvement would be some images to go
along with the code examples to show the shapes that are being constructed.

Is this a typo:

Hyperplanes place a key role in *Commons Geometry*

'play' a key role?

Reply via email to