Skip to content

Commit 071ee05

Browse files
authored
docs: fix javadoc blocking snapshot release (#889)
1 parent 7658e31 commit 071ee05

File tree

3 files changed

+8
-3
lines changed

3 files changed

+8
-3
lines changed

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/EventSourceInitializer.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ public interface EventSourceInitializer<P extends HasMetadata> {
1818
*
1919
* @param context a {@link EventSourceContext} providing access to information useful to event
2020
* sources
21+
* @return list of event sources to register
2122
*/
2223
List<EventSource> prepareEventSources(EventSourceContext<P> context);
2324

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/ReconciliationMaxInterval.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,13 @@
1515
* reconciliation is scheduled with a target interval after the last reconciliation. Note that
1616
* this not applies for retries, in case of an exception reconciliation is not scheduled. This is
1717
* not a fixed rate, in other words a new reconciliation is scheduled after each reconciliation.
18-
* <p/>
18+
* <p>
1919
* If an interval is specified by {@link UpdateControl} or {@link DeleteControl}, those take
2020
* precedence.
21-
* <p/>
21+
* <p>
2222
* This is a fail-safe feature, in the sense that if informers are in place and the reconciler
2323
* implementation is correct, this feature can be turned off.
24-
* <p/>
24+
* <p>
2525
* Use NO_RECONCILIATION_MAX_INTERVAL in {@link Constants} to turn off this feature.
2626
*
2727
* @return max delay between reconciliations

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/reconciler/UpdateControl.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,10 @@ private UpdateControl(
2323
* Creates an update control instance that instructs the framework to do an update on resource
2424
* itself, not on the status. Note that usually as a results of a reconciliation should be a
2525
* status update not an update to the resource itself.
26+
*
27+
* @param <T> custom resource type
28+
* @param customResource customResource to use for update
29+
* @return initialized update control
2630
*/
2731
public static <T extends HasMetadata> UpdateControl<T> updateResource(T customResource) {
2832
return new UpdateControl<>(customResource, false, true);

0 commit comments

Comments
 (0)