paion-data/elide

Aggregating Javadoc is not working

Closed this issue · 0 comments

Goal

Support generating aggregated Javadoc

Overview

Since Elide is a multi-module project, executing the javadoc:aggregate goal should generate a consolidated javadocs under elide/target directory with the following command:

mvn clean verify javadoc:aggregate

What actually happened, which seems wrong, is that each child module's Javadoc gets generated in their respective sub-directories:

find . -name index.html | grep apidocs

./elide-spring/elide-spring-boot-autoconfigure/target/apidocs/index.html
./elide-core/target/apidocs/index.html
./elide-test/target/apidocs/index.html
./elide-quarkus/runtime/target/apidocs/index.html
./elide-datastore/elide-datastore-noop/target/apidocs/index.html
./elide-datastore/elide-datastore-multiplex/target/apidocs/index.html
./elide-datastore/elide-datastore-jpa/target/apidocs/index.html
./elide-datastore/elide-datastore-aggregation/target/apidocs/index.html
./elide-datastore/elide-datastore-jpql/target/apidocs/index.html
./elide-datastore/elide-datastore-jms/target/apidocs/index.html
./elide-datastore/elide-datastore-inmemorydb/target/apidocs/index.html
./elide-datastore/elide-datastore-search/target/apidocs/index.html
./elide-swagger/target/apidocs/index.html
./elide-model-config/target/apidocs/index.html
./elide-async/target/apidocs/index.html
./elide-standalone/target/apidocs/index.html
./elide-graphql/target/apidocs/index.html

Note

Each index.html is a Javadoc homepage for a child module

We should instead aggregate all of those Javadocs into the top elide/target directory. This is very important for building a better Elide documentation on elide.paion-data.dev