From 74b3ea92b03c6979ad490c155a5bc4fc99f58d6c Mon Sep 17 00:00:00 2001 From: Paul Campbell Date: Thu, 5 Aug 2021 08:07:02 +0100 Subject: [PATCH] Fix javadoc (#218) * github/workflow/build: verify javadoc * github/workflow/deploy: only publish javadoc after successful deploy to sonatype * result: fix javadoc * result: fix javadoc (jdk 16 flagged) --- .github/workflows/build-maven.yml | 2 ++ .github/workflows/deploy-sonatype.yml | 10 ---------- .../java/net/kemitix/mon/result/BaseResult.java | 6 +++--- .../java/net/kemitix/mon/result/ErrVoid.java | 3 +++ src/main/java/net/kemitix/mon/result/Result.java | 16 ++++++++-------- .../java/net/kemitix/mon/result/ResultVoid.java | 12 ++++++------ .../java/net/kemitix/mon/result/SuccessVoid.java | 4 +++- .../net/kemitix/mon/result/package-info.java | 2 +- 8 files changed, 26 insertions(+), 29 deletions(-) diff --git a/.github/workflows/build-maven.yml b/.github/workflows/build-maven.yml index 76fae11..80e665a 100644 --- a/.github/workflows/build-maven.yml +++ b/.github/workflows/build-maven.yml @@ -21,3 +21,5 @@ jobs: java-version: ${{ matrix.java }} - name: build-jar run: mvn -B install + - name: verify javadoc + run: mvn -P release javadoc:javadoc diff --git a/.github/workflows/deploy-sonatype.yml b/.github/workflows/deploy-sonatype.yml index 1f68fe6..1475c8b 100644 --- a/.github/workflows/deploy-sonatype.yml +++ b/.github/workflows/deploy-sonatype.yml @@ -38,16 +38,6 @@ jobs: NEXUS_PASSWORD: ${{ secrets.NEXUS_PASSWORD }} GPG_KEYNAME: ${{ secrets.GPG_KEYNAME }} GPG_PASSPHRASE: ${{ secrets.GPG_PASSPHRASE }} - javadoc: - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - - uses: actions/setup-java@v2.1.0 - with: - distribution: adopt - java-version: 16 - - name: create-javadoc - run: mvn -B javadoc:javadoc - name: Publish Javadoc uses: JamesIves/github-pages-deploy-action@4.1.4 with: diff --git a/src/main/java/net/kemitix/mon/result/BaseResult.java b/src/main/java/net/kemitix/mon/result/BaseResult.java index f83703d..b565fa1 100644 --- a/src/main/java/net/kemitix/mon/result/BaseResult.java +++ b/src/main/java/net/kemitix/mon/result/BaseResult.java @@ -28,7 +28,7 @@ public interface BaseResult { * Checks if the Result is a success. * * 

-     * boolean isOkay = Result.of(() -> getValue())
+     * boolean isOkay = Result.of(() -> getValue())
      *                        .isOkay();
      *
* @@ -49,8 +49,8 @@ public interface BaseResult { * * 

      * void handleError(Throwable e) {...}
-     * Result.of(() -> doSomething())
-     *       .onError(e -> handleError(e));
+     * Result.of(() -> doSomething())
+     *       .onError(e -> handleError(e));
      *
* * @param errorConsumer the consumer to handle the error diff --git a/src/main/java/net/kemitix/mon/result/ErrVoid.java b/src/main/java/net/kemitix/mon/result/ErrVoid.java index 55c2b5f..edb3f76 100644 --- a/src/main/java/net/kemitix/mon/result/ErrVoid.java +++ b/src/main/java/net/kemitix/mon/result/ErrVoid.java @@ -4,6 +4,9 @@ import java.util.Objects; import java.util.function.Consumer; import java.util.function.Function; +/** + * An Error Result with no value type. + */ public class ErrVoid implements ResultVoid { private final Throwable error; diff --git a/src/main/java/net/kemitix/mon/result/Result.java b/src/main/java/net/kemitix/mon/result/Result.java index d569d3e..20563a2 100644 --- a/src/main/java/net/kemitix/mon/result/Result.java +++ b/src/main/java/net/kemitix/mon/result/Result.java @@ -607,8 +607,8 @@ public interface Result extends BaseResult, ThrowableFunctor - * ResultVoid result = Result.of(() -> getValue()) - * .flatMapV(v -> Result.ok()); + * ResultVoid result = Result.of(() -> getValue()) + * .flatMapV(v -> Result.ok()); * * * @param f the mapping function the produces a ResultVoid @@ -648,10 +648,10 @@ public interface Result extends BaseResult, ThrowableFunctor - * Result.of(()-> getValue()) + * Result.of(()-> getValue()) * .match( - * success -> doSomething(success), - * error -> handleError(error) + * success -> doSomething(success), + * error -> handleError(error) * ); * * @@ -683,7 +683,7 @@ public interface Result extends BaseResult, ThrowableFunctor * Result<Integer> result = Result.of(() -> getValue()) - * .recover(e -> Result.of(() -> getSafeValue(e))); + * .recover(e -> Result.of(() -> getSafeValue(e))); * * * @param f the function to recover from the error @@ -699,8 +699,8 @@ public interface Result extends BaseResult, ThrowableFunctor * void handleSuccess(Integer value) {...} - * Result.of(() -> getValue()) - * .onSuccess(v -> handleSuccess(v)); + * Result.of(() -> getValue()) + * .onSuccess(v -> handleSuccess(v)); * * *

When this is a success then tne Consumer will be supplied with the diff --git a/src/main/java/net/kemitix/mon/result/ResultVoid.java b/src/main/java/net/kemitix/mon/result/ResultVoid.java index 1d77b3c..74c9e43 100644 --- a/src/main/java/net/kemitix/mon/result/ResultVoid.java +++ b/src/main/java/net/kemitix/mon/result/ResultVoid.java @@ -20,8 +20,8 @@ public interface ResultVoid extends BaseResult { * 


      * Result.ok()
      *       .match(
-     *           () -> doSomething(),
-     *           error -> handleError(error)
+     *           () -> doSomething(),
+     *           error -> handleError(error)
      *       );
      *
* @@ -39,8 +39,8 @@ public interface ResultVoid extends BaseResult { * * 

      * void doSomethingRisky(String s) throws Exception {...}
-     * ResultVoid result = Result.ofVoid(() -> doSomethingRisky("first"))
-     *                           .recover(e -> Result.ofVoid(() -> doSomethingRisky("second")));
+     * ResultVoid result = Result.ofVoid(() -> doSomethingRisky("first"))
+     *                           .recover(e -> Result.ofVoid(() -> doSomethingRisky("second")));
      *
* * @param f the function to recover from the error @@ -58,8 +58,8 @@ public interface ResultVoid extends BaseResult { * 

      * void doSomethingRisky() throws Exception {...}
      * void handleSuccess() {...}
-     * Result.ofVoid(() -> doSomethingRisky()) // ResultVoid
-     *       .onSuccess(() -> handleSuccess());
+     * Result.ofVoid(() -> doSomethingRisky()) // ResultVoid
+     *       .onSuccess(() -> handleSuccess());
      *
* *

When this is a success then tne Consumer will be supplied with the diff --git a/src/main/java/net/kemitix/mon/result/SuccessVoid.java b/src/main/java/net/kemitix/mon/result/SuccessVoid.java index 7d099ea..5b70d64 100644 --- a/src/main/java/net/kemitix/mon/result/SuccessVoid.java +++ b/src/main/java/net/kemitix/mon/result/SuccessVoid.java @@ -7,8 +7,10 @@ import java.util.Objects; import java.util.function.Consumer; import java.util.function.Function; +/** + * The Successful Result, with no value. + */ @NoArgsConstructor(access = AccessLevel.PRIVATE) -@SuppressWarnings("PMD.AvoidDuplicateLiterals") public class SuccessVoid implements ResultVoid { private static final ResultVoid INSTANCE = new SuccessVoid(); diff --git a/src/main/java/net/kemitix/mon/result/package-info.java b/src/main/java/net/kemitix/mon/result/package-info.java index 61fb32e..55c877f 100644 --- a/src/main/java/net/kemitix/mon/result/package-info.java +++ b/src/main/java/net/kemitix/mon/result/package-info.java @@ -20,7 +20,7 @@ */ /** - *

Result

+ * <h1>Result</h1> * * Allows handling error conditions without the need to {@code catch} * exceptions.