Fixing Javadoc that blocks the snapshot release

Author: csviri

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

@@ -34,6 +34,9 @@ public static <T extends CustomResource> UpdateControl<T> updateStatusSubResourc
   /**
    * As a results of this there will be two call to K8S API. First the custom resource will be
    * updates then the status sub-resource.
+   * 
+   * @param customResource - custom resource to use in both API calls
+   * @return UpdateControl instance
    */
   public static <T extends CustomResource> UpdateControl<T> updateCustomResourceAndStatus(
       T customResource) {

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/AbstractControllerConfiguration.java

@@ -19,7 +19,7 @@ public AbstractControllerConfiguration(String associatedControllerClassName, Str
       Set<String> namespaces,
       RetryConfiguration retryConfiguration) {
     super(associatedControllerClassName, name, crdName, finalizer, generationAware, namespaces,
-        retryConfiguration);
+        retryConfiguration, null, null, null, null);
   }
 
   public AbstractControllerConfiguration(String associatedControllerClassName, String name,

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/ControllerConfiguration.java

@@ -103,12 +103,11 @@ default boolean useFinalizer() {
 
   /**
    * Allow controllers to filter events before they are provided to the
-   * {@link io.javaoperatorsdk.operator.processing.event.EventHandler}.
-   * </p>
-   * Note that the provided filter is combined with {@link #isGenerationAware()} to compute the
-   * final set of fiolters that should be applied;
+   * {@link io.javaoperatorsdk.operator.processing.event.EventHandler}. Note that the provided
+   * filter is combined with {@link #isGenerationAware()} to compute the final set of fiolters that
+   * should be applied;
    *
-   * @return
+   * @return filter
    */
   default CustomResourceEventFilter<R> getEventFilter() {
     return CustomResourceEventFilters.passthrough();

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/api/config/DefaultControllerConfiguration.java

@@ -54,34 +54,6 @@ public DefaultControllerConfiguration(
     setConfigurationService(service);
   }
 
-  /**
-   * @deprecated use
-   *             {@link #DefaultControllerConfiguration(String, String, String, String, boolean, Set, RetryConfiguration)}
-   *             instead
-   */
-  @Deprecated
-  public DefaultControllerConfiguration(
-      String associatedControllerClassName,
-      String name,
-      String crdName,
-      String finalizer,
-      boolean generationAware,
-      Set<String> namespaces,
-      RetryConfiguration retryConfiguration) {
-    this(
-        associatedControllerClassName,
-        name,
-        crdName,
-        finalizer,
-        generationAware,
-        namespaces,
-        retryConfiguration,
-        null,
-        null,
-        null,
-        null);
-  }
-
   @Override
   public String getName() {
     return name;

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/CustomResourceCache.java

@@ -69,8 +69,8 @@ public void cacheResource(T resource, Predicate<T> predicate) {
    * We clone the object so the one in the cache is not changed by the controller or dispatcher.
    * Therefore the cached object always represents the object coming from the API server.
    *
-   * @param uuid
-   * @return
+   * @param uuid identifier of resource
+   * @return resource if found in cache
    */
   public Optional<T> getLatestResource(String uuid) {
     return Optional.ofNullable(resources.get(uuid)).map(this::clone);

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/event/Event.java

@@ -17,6 +17,7 @@ public interface Event {
   /**
    * The selector used to determine the {@link CustomResource} for which a reconcile loop should be
    * triggered.
+   * @return predicate used to match the target CustomResource
    */
   Predicate<CustomResource> getCustomResourcesSelector();
 

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/retry/RetryExecution.java

@@ -10,7 +10,7 @@ public interface RetryExecution extends RetryInfo {
    * Calculates the delay for the next execution. This method should return 0, when called first
    * time;
    *
-   * @return
+   * @return the time to wait until the next execution in milliseconds
    */
   Optional<Long> nextDelay();
 }