On Mon, 16 Aug 2021 at 15:18, Matt Juntunen <[email protected]>
wrote:

> I'm cancelling this vote again to address some of the issues that Alex
> found, particularly the method naming convention issue.
>
> Alex,
> The behavior you described for the AbstractNode.depth() method is as
> designed. It is not sufficient for a node to not have a parent in
> order to be considered a root node; it must have been explicitly set
> as the root in the parent tree. This is done with the
> AbstractBSPTree.setRoot() method, which calls AbstractNode.makeRoot()
> and initializes the depth to 0.
>

OK. So it is a node that is not yet part of a tree. Perhaps a comment to
reflect this would help.


>
> I've addressed some of the issues you mentioned in a new PR [1].
> Please take a look and let me know if you think it's good to go. If
> so, I can try to get another RC out today.
>

I build the PR locally to check the javadoc links. I get a warning that the
links cannot be found.

According to the javadoc plugin there must be a package-list file available
at the given URL [1].

Looking at the live site (via the svn checkout) there are package-list
files for the beta release but not the 1.0 release:

find . -name package-list
./commons-numbers-arrays/javadocs/api-1.0-beta1/package-list
./commons-numbers-field/javadocs/api-1.0-beta1/package-list
./commons-numbers-gamma/javadocs/api-1.0-beta1/package-list
./commons-numbers-fraction/javadocs/api-1.0-beta1/package-list
./commons-numbers-core/javadocs/api-1.0-beta1/package-list
./commons-numbers-angle/javadocs/api-1.0-beta1/package-list
./commons-numbers-primes/javadocs/api-1.0-beta1/package-list
./commons-numbers-combinatorics/javadocs/api-1.0-beta1/package-list
./commons-numbers-rootfinder/javadocs/api-1.0-beta1/package-list
./commons-numbers-complex/javadocs/api-1.0-beta1/package-list
./commons-numbers-quaternion/javadocs/api-1.0-beta1/package-list

So when the site was generated for the 1.0 release the package-list files
are missing. This would be due to using JDK 11 to build the javadoc. JDK 11
does not generate a package-list. It creates an element-list file instead
for use with modules. These are present in the numbers api-1.0 directories.
It seems that javadoc produces either a package-list or an element-list
file, so you can't mix unnamed modules (packages) with named modules.

I just tried with numbers locally for one of the maven modules this command:

mvn site -DskipTests

Using JDK 11 this is created:

./target/javadoc-bundle-options/package-list

On JDK 8 this is created:

./target/site/apidocs/package-list
./target/javadoc-bundle-options/package-list

So with JDK 11 the site would not have the package-list files.

Since geometry and numbers are using packages then the javadoc should be
produced using JDK 8. The workaround would be to add the package-list files
manually to the numbers site.

These files are very simple. So it may be enough to just copy the ones from
the api-1.0-beta1 directory to the api-1.0 directory. This assumes the rest
of the javadoc site structure is the same. Otherwise the numbers site will
have to be regenerated with JDK 8 for the javadocs.

Alex


[1]
https://maven.apache.org/plugins/maven-javadoc-plugin/examples/links-configuration.html

Reply via email to