Skip to content

Commit 0c555aa

Browse files
Fixed JavaDoc issues
1 parent 7f918dd commit 0c555aa

File tree

5 files changed

+44
-0
lines changed

5 files changed

+44
-0
lines changed

validator-bval/pom.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,16 @@
7878
</configuration>
7979
</plugin>
8080

81+
<plugin>
82+
<groupId>org.apache.maven.plugins</groupId>
83+
<artifactId>maven-javadoc-plugin</artifactId>
84+
<configuration>
85+
<sourceFileExcludes>
86+
<exclude>**/ApacheBValBeanValidationImplementationHelper.java</exclude>
87+
</sourceFileExcludes>
88+
</configuration>
89+
</plugin>
90+
8191
<plugin>
8292
<groupId>org.apache.maven.plugins</groupId>
8393
<artifactId>maven-surefire-plugin</artifactId>

validator-core/pom.xml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,18 @@
9696
</executions>
9797
</plugin>
9898

99+
<plugin>
100+
<groupId>org.apache.maven.plugins</groupId>
101+
<artifactId>maven-javadoc-plugin</artifactId>
102+
<configuration>
103+
<excludePackageNames>com.github.microtweak.validator.conditional.core.exception.*:com.github.microtweak.validator.conditional.core.internal.*:com.github.microtweak.validator.conditional.core.spi.*</excludePackageNames>
104+
<sourceFileExcludes>
105+
<exclude>**/DelegatedConditionalConstraintValidator.java</exclude>
106+
<exclude>**/ExpressionEvaluator.java</exclude>
107+
</sourceFileExcludes>
108+
</configuration>
109+
</plugin>
110+
99111
<plugin>
100112
<groupId>org.apache.maven.plugins</groupId>
101113
<artifactId>maven-surefire-plugin</artifactId>

validator-core/src/main/java/com/github/microtweak/validator/conditional/core/ConditionalValidate.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,18 @@
99
import static java.lang.annotation.ElementType.TYPE;
1010
import static java.lang.annotation.RetentionPolicy.RUNTIME;
1111

12+
/**
13+
* When a class is annotated with @ConditionalValidate, all of its fields can be annotated with any conditional constraint.
14+
*/
1215
@Constraint(validatedBy = DelegatedConditionalConstraintValidator.class)
1316
@Documented
1417
@Target(TYPE)
1518
@Retention(RUNTIME)
1619
public @interface ConditionalValidate {
1720

21+
/**
22+
* Enums that will be available during the evaluation of the expression of each conditional constraint
23+
*/
1824
Class<?>[] contextClasses() default {};
1925

2026
/**

validator-core/src/main/java/com/github/microtweak/validator/conditional/core/WhenActivatedValidateAs.java

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,16 @@
77
import static java.lang.annotation.ElementType.ANNOTATION_TYPE;
88
import static java.lang.annotation.RetentionPolicy.RUNTIME;
99

10+
/**
11+
* Indicates which Bean Validation constraint should be used when the conditional constraint is enabled
12+
*/
1013
@Target({ ANNOTATION_TYPE })
1114
@Retention(RUNTIME)
1215
public @interface WhenActivatedValidateAs {
1316

17+
/**
18+
* BeanValidation annotation/constraint class to use
19+
*/
1420
Class<? extends Annotation> value();
1521

1622
}

validator-hv/pom.xml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,16 @@
7373
</configuration>
7474
</plugin>
7575

76+
<plugin>
77+
<groupId>org.apache.maven.plugins</groupId>
78+
<artifactId>maven-javadoc-plugin</artifactId>
79+
<configuration>
80+
<sourceFileExcludes>
81+
<exclude>**/HVBeanValidationImplementationHelper.java</exclude>
82+
</sourceFileExcludes>
83+
</configuration>
84+
</plugin>
85+
7686
<plugin>
7787
<groupId>org.apache.maven.plugins</groupId>
7888
<artifactId>maven-surefire-plugin</artifactId>

0 commit comments

Comments
 (0)