Fix javadoc

Coreoz · Nov 21, 2024 · 9bca302 · 9bca302
1 parent 9ef77f2
commit 9bca302
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 20 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -47,3 +47,5 @@ jobs:
           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
           SONAR_HOST_URL: ${{ vars.SONAR_HOST_URL }}
         run: mvn -B clean verify -P coverage org.sonarsource.scanner.maven:sonar-maven-plugin:sonar -Dsonar.projectKey=Coreoz_Plume -Dsonar.organization=coreoz
+      - name: Maven release analysis
+        run: mvn install -P release
diff --git a/...-db-querydsl/src/main/java/com/coreoz/plume/db/querydsl/pagination/SqlPaginatedQuery.java b/...-db-querydsl/src/main/java/com/coreoz/plume/db/querydsl/pagination/SqlPaginatedQuery.java
@@ -18,8 +18,8 @@
  * @param <U> The type of elements contained in the request.
  * <br>
  * Usage example:
- * <code><pre>
- * public Page<User> fetchUsers() {
+ * <code>
+ * public Page&lt;User&gt; fetchUsers() {
  *   return SqlPaginatedQuery
  *             .fromQuery(
  *                 this.transactionManagerQuerydsl.selectQuery()
@@ -29,7 +29,7 @@
  *             .withSort(QUser.user.name, Order.DESC)
  *             .fetchPage(1, 10);
  * }
- * </pre></code>
+ * </code>
  */
 public class SqlPaginatedQuery<U> {
 

diff --git a/plume-db/src/main/java/com/coreoz/plume/db/pagination/Page.java b/plume-db/src/main/java/com/coreoz/plume/db/pagination/Page.java
@@ -31,11 +31,11 @@ public record Page<T>(
      * @param <U> The type of elements to be mapped to in the page.
      * <br>
      * Usage example:
-     * <code><pre>
-     * public Page<UserUpdated> fetchUsers() {
-     *   return this.userService.fetchPage(1, 10).map(user -> new UserUpdated(user));
+     * <code>
+     * public Page&lt;UserUpdated&gt; fetchUsers() {
+     *   return this.userService.fetchPage(1, 10).map(user -&gt; new UserUpdated(user));
      * }
-     * </pre></code>
+     * </code>
      */
     public <U> Page<U> map(@Nonnull Function<T, U> mapper) {
         return new Page<>(

diff --git a/plume-db/src/main/java/com/coreoz/plume/db/pagination/Slice.java b/plume-db/src/main/java/com/coreoz/plume/db/pagination/Slice.java
@@ -25,11 +25,11 @@ public record Slice<T>(
      * @param <U> The type of elements to be mapped to in the slice.
      * <br>
      * Usage example:
-     * <code><pre>
-     * public Page<UserUpdated> fetchUsers() {
-     *   return this.userService.fetchSlice(1, 10).map(user -> new UserUpdated(user));
+     * <code>
+     * public Page&lt;UserUpdated&gt; fetchUsers() {
+     *   return this.userService.fetchSlice(1, 10).map(user -&gt; new UserUpdated(user));
      * }
-     * </pre></code>
+     * </code>
      */
     public <U> Slice<U> map(@Nonnull Function<T, U> mapper) {
         return new Slice<>(

diff --git a/plume-web-jersey/src/main/java/com/coreoz/plume/jersey/async/AsyncJersey.java b/plume-web-jersey/src/main/java/com/coreoz/plume/jersey/async/AsyncJersey.java
@@ -22,14 +22,14 @@ public class AsyncJersey {
 	 * that should be called when a {@link CompletableFuture} is terminated.<br>
 	 * <br>
 	 * Usage example:
-	 * <code><pre>
+	 * <code>
 	 * &commat;GET
 	 * public void fetchAsync(@Suspended AsyncResponse asyncResponse) {
 	 *   asyncService
 	 *     .fetchDataAsync()
 	 *     .whenCompleteAsync(toAsyncConsumer(asyncResponse));
 	 * }
-	 * </pre></code>
+	 * </code>
 	 */
     @Nonnull
 	public static <T, U extends Throwable> BiConsumer<T, U> toAsyncConsumer(@Nonnull AsyncResponse asyncResponse) {

diff --git a/plume-web-jersey/src/main/java/com/coreoz/plume/jersey/errors/WsJacksonJsonProvider.java b/plume-web-jersey/src/main/java/com/coreoz/plume/jersey/errors/WsJacksonJsonProvider.java
@@ -18,7 +18,6 @@
  * A Jackson JSON provider that throws a {@link JsonRequestParseException}
  * during the parsing.
  * It is useful to return proper 400 errors when JSON request input is not valid
- * @see JacksonJaxbJsonProvider
  */
 @Slf4j
 public class WsJacksonJsonProvider extends JacksonJsonProvider {

diff --git a/pom.xml b/pom.xml
@@ -65,8 +65,6 @@
 		<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 		<maven.compiler.source>17</maven.compiler.source>
 		<maven.compiler.target>17</maven.compiler.target>
-		<javadoc.java-version>8</javadoc.java-version>
-		<additionalparam>-Xdoclint:none</additionalparam>
         <sonar.coverage.jacoco.xmlReportPaths>${project.basedir}/samples/target/site/ jacoco-aggregate/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
 	</properties>
 
@@ -115,10 +113,9 @@
 								</goals>
 							</execution>
 						</executions>
-						<configuration>
-							<stylesheet>java</stylesheet>
-							<source>${javadoc.java-version}</source>
-						</configuration>
+                        <configuration>
+                            <doclint>all,-missing</doclint>
+                        </configuration>
 					</plugin>
 					<plugin>
 						<groupId>org.apache.maven.plugins</groupId>