diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index a8c84f8c..103661b3 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -31,3 +31,19 @@ jobs: - name: Build with Maven run: mvn package + verify-javadoc: + runs-on: ubuntu-latest + name: Validate JavaDocs + steps: + - uses: actions/checkout@v4 + - name: Setup JDK + uses: actions/setup-java@v4 + with: + distribution: 'temurin' + java-version: '23' + architecture: 'x64' + cache: 'maven' + + - name: Validate JavaDocs + run: mvn -Pdoclint package -DskipTests=true + diff --git a/pom.xml b/pom.xml index a37e5fc3..8fa7d9b8 100644 --- a/pom.xml +++ b/pom.xml @@ -1,5 +1,6 @@ - + @@ -25,11 +26,12 @@ https://github.com/pivovarit/parallel-collectors scm:git:git@github.com:pivovarit/parallel-collectors.git scm:git:git@github.com:pivovarit/parallel-collectors.git - HEAD - + HEAD + UTF-8 + 3.10.1 5.11.2 3.26.3 4.2.2 @@ -47,8 +49,7 @@ maven-compiler-plugin 3.13.0 - 21 - 21 + 21 @@ -126,7 +127,7 @@ org.apache.maven.plugins maven-javadoc-plugin - 3.10.1 + ${maven.javadoc.plugin.version} attach-javadocs @@ -247,6 +248,30 @@ + + doclint + + + + org.apache.maven.plugins + maven-javadoc-plugin + ${maven.javadoc.plugin.version} + + + attach-javadocs + + jar + + + + + true + true + + + + + diff --git a/src/main/java/com/pivovarit/collectors/ParallelCollectors.java b/src/main/java/com/pivovarit/collectors/ParallelCollectors.java index 0ea272bd..3a16bdfc 100644 --- a/src/main/java/com/pivovarit/collectors/ParallelCollectors.java +++ b/src/main/java/com/pivovarit/collectors/ParallelCollectors.java @@ -28,11 +28,11 @@ private ParallelCollectors() { * .collect(parallel(i -> foo(i), toList())); * } * - * @param mapper a transformation to be performed in parallel - * @param collector the {@code Collector} describing the reduction - * @param the type of the collected elements - * @param the result returned by {@code mapper} - * @param the reduction result {@code collector} + * @param mapper a transformation to be performed in parallel + * @param collector the {@code Collector} describing the reduction + * @param the type of the collected elements + * @param the result returned by {@code mapper} + * @param the reduction result {@code collector} * * @return a {@code Collector} which collects all processed elements into a user-provided mutable {@code Collection} in parallel * @@ -106,12 +106,12 @@ private ParallelCollectors() { * .collect(parallel(i -> foo(i), toList(), executor)); * } * - * @param mapper a transformation to be performed in parallel - * @param collector the {@code Collector} describing the reduction - * @param executor the {@code Executor} to use for asynchronous execution - * @param the type of the collected elements - * @param the result returned by {@code mapper} - * @param the reduction result {@code collector} + * @param mapper a transformation to be performed in parallel + * @param collector the {@code Collector} describing the reduction + * @param executor the {@code Executor} to use for asynchronous execution + * @param the type of the collected elements + * @param the result returned by {@code mapper} + * @param the reduction result {@code collector} * * @return a {@code Collector} which collects all processed elements into a user-provided mutable {@code Collection} in parallel * @@ -135,9 +135,9 @@ private ParallelCollectors() { * .collect(parallel(i -> foo())); * } * - * @param mapper a transformation to be performed in parallel - * @param the type of the collected elements - * @param the result returned by {@code mapper} + * @param mapper a transformation to be performed in parallel + * @param the type of the collected elements + * @param the result returned by {@code mapper} * * @return a {@code Collector} which collects all processed elements into a {@code Stream} in parallel * @@ -162,6 +162,7 @@ private ParallelCollectors() { * } * * @param mapper a transformation to be performed in parallel + * @param parallelism the max parallelism level * @param the type of the collected elements * @param the result returned by {@code mapper} * @@ -215,10 +216,10 @@ private ParallelCollectors() { * .collect(parallel(i -> foo(), executor)); * } * - * @param mapper a transformation to be performed in parallel - * @param executor the {@code Executor} to use for asynchronous execution - * @param the type of the collected elements - * @param the result returned by {@code mapper} + * @param mapper a transformation to be performed in parallel + * @param executor the {@code Executor} to use for asynchronous execution + * @param the type of the collected elements + * @param the result returned by {@code mapper} * * @return a {@code Collector} which collects all processed elements into a {@code Stream} in parallel * @@ -242,9 +243,9 @@ private ParallelCollectors() { * .forEach(System.out::println); * } * - * @param mapper a transformation to be performed in parallel - * @param the type of the collected elements - * @param the result returned by {@code mapper} + * @param mapper a transformation to be performed in parallel + * @param the type of the collected elements + * @param the result returned by {@code mapper} * * @return a {@code Collector} which collects all processed elements into a {@code Stream} in parallel * @@ -295,10 +296,10 @@ private ParallelCollectors() { * .forEach(System.out::println); * } * - * @param mapper a transformation to be performed in parallel - * @param executor the {@code Executor} to use for asynchronous execution - * @param the type of the collected elements - * @param the result returned by {@code mapper} + * @param mapper a transformation to be performed in parallel + * @param executor the {@code Executor} to use for asynchronous execution + * @param the type of the collected elements + * @param the result returned by {@code mapper} * * @return a {@code Collector} which collects all processed elements into a {@code Stream} in parallel * @@ -350,9 +351,9 @@ private ParallelCollectors() { * .forEach(System.out::println); * } * - * @param mapper a transformation to be performed in parallel - * @param the type of the collected elements - * @param the result returned by {@code mapper} + * @param mapper a transformation to be performed in parallel + * @param the type of the collected elements + * @param the result returned by {@code mapper} * * @return a {@code Collector} which collects all processed elements into a {@code Stream} in parallel * @@ -403,10 +404,10 @@ private ParallelCollectors() { * .forEach(System.out::println); * } * - * @param mapper a transformation to be performed in parallel - * @param executor the {@code Executor} to use for asynchronous execution - * @param the type of the collected elements - * @param the result returned by {@code mapper} + * @param mapper a transformation to be performed in parallel + * @param executor the {@code Executor} to use for asynchronous execution + * @param the type of the collected elements + * @param the result returned by {@code mapper} * * @return a {@code Collector} which collects all processed elements into a {@code Stream} in parallel * diff --git a/src/main/java/module-info.java b/src/main/java/module-info.java index 3ed46d4e..6c5663d4 100644 --- a/src/main/java/module-info.java +++ b/src/main/java/module-info.java @@ -1,3 +1,6 @@ +/** + * Parallel Collectors is a toolkit that eases parallel collection processing in Java using Stream API without the limitations imposed by standard Parallel Streams + */ module parallel.collectors { exports com.pivovarit.collectors; }