Skip to content

Commit

Permalink
Fix broken javadoc processing
Browse files Browse the repository at this point in the history
  • Loading branch information
stijn-dejongh committed Dec 25, 2023
1 parent 9556427 commit 281a4de
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 4 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/build_mainline.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,10 @@ jobs:
- uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
token: ${{ secrets.REPO_TOKEN }}
fetch-depth: 2


- name: Set up JDK 21
uses: actions/setup-java@v1
with:
Expand Down
3 changes: 2 additions & 1 deletion src/main/java/be/sddevelopment/validation/Checked.java
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,10 @@
* The result of said evaluation is represented by a {@link EvaluationRationale}.
* The original object is maintained as well, to allow for further processing, and flexibility in dealing with various validation states.
*
* Intended as a <a href="https://en.wikipedia.org/wiki/Monad_(functional_programming)">monadic structure</a> to allow for fluent programming with the result of a validation.
*
* @author stijnd
* @version 1.0.0-SNAPSHOT
* @apiNote Intended as a <a href="https://en.wikipedia.org/wiki/Monad_(functional_programming)">monadic structure</a> to allow for fluent programming with the result of a validation.
*/
public final class Checked<T> {

Expand Down
3 changes: 2 additions & 1 deletion src/main/java/be/sddevelopment/validation/Reason.java
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,9 @@
* Represents the evaluation of a single {@link ValidationRule}, and will be included in a {@link EvaluationRationale}.
* Each reason will tell the user whether a particular rule passed or failed, and will include a description (aka "rationale") to explain why a certain result was achieved.
*
* This class is immutable, and provides static factory methods to simplify usage, and increase readability..
*
* @version 1.0.0-SNAPSHOT
* @apiNote This class is immutable, and provides static factory methods to simplify usage, and increase readability..
* @since 1.0.0-SNAPSHOT
*/
public record Reason(String rationale, Evaluation result) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,9 @@
* <p>ValidationRule class.</p>
* Represents a single validation rule, which can be applied to an object of any type.
*
* @param rule a method that accepts an object of type <T> and returns a boolean that indicates if it matches the validation criterium.
* @param rule a method that accepts an object of type T and returns a boolean that indicates if it matches the validation criterium.
* @param description textual description of the validation rule
* @param <T> type of the object onto which the rule can be applied
* @apiNote This class is immutable
*/
public record ValidationRule<T>(Predicate<T> rule, String description) {
}

0 comments on commit 281a4de

Please sign in to comment.