Skip to content

Commit 92f2ff6

Browse files
committed
docs: fix javadoc issues (#1887)
1 parent 137f6fc commit 92f2ff6

File tree

3 files changed

+7
-3
lines changed

3 files changed

+7
-3
lines changed

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ResolvedControllerConfiguration.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ public ResourceEventFilter<P> getEventFilter() {
157157
/**
158158
* @deprecated Use {@link OnAddFilter}, {@link OnUpdateFilter} and {@link GenericFilter} instead
159159
*
160-
* @param eventFilter
160+
* @param eventFilter generic event filter
161161
*/
162162
@Deprecated(forRemoval = true)
163163
protected void setEventFilter(ResourceEventFilter<P> eventFilter) {

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/DependentResourceWithExplicitState.java

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ default Optional<String> eventSourceName() {
2828

2929
/**
3030
* Class of the state resource.
31+
*
32+
* @return the type of the resource that stores state
3133
*/
3234
Class<S> stateResourceClass();
3335

Diff for: operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/GenericKubernetesResourceMatcher.java

+4-2
Original file line numberDiff line numberDiff line change
@@ -39,18 +39,20 @@ static <R extends HasMetadata, P extends HasMetadata> Matcher<R, P> matcherFor(
3939

4040
/**
4141
* {@inheritDoc}
42-
* <p/>
42+
* <p>
4343
* This implementation attempts to cover most common cases out of the box by considering
4444
* non-additive changes to the resource's spec (if the resource in question has a {@code spec}
4545
* field), making special provisions for {@link ConfigMap} and {@link Secret} resources. Additive
4646
* changes (i.e. a field is added that previously didn't exist) are not considered as triggering a
4747
* mismatch by default to account for validating webhooks that might add default values
4848
* automatically when not present or some other controller adding labels and/or annotations.
49-
* <p/>
49+
* </p>
50+
* <p>
5051
* It should be noted that this implementation is potentially intensive because it generically
5152
* attempts to cover common use cases by performing diffs on the JSON representation of objects.
5253
* If performance is a concern, it might be easier / simpler to provide a {@link Matcher}
5354
* implementation optimized for your use case.
55+
* </p>
5456
*/
5557
@Override
5658
public Result<R> match(R actualResource, P primary, Context<P> context) {

0 commit comments

Comments
 (0)