chore(docs): fix javadoc issue

Author: metacosm

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

@@ -17,13 +17,17 @@
   /**
    * Optional finalizer name, if it is not, the crdName will be used as the name of the finalizer
    * too.
+   *
+   * @return the finalizer name
    */
   String finalizerName() default NULL;
 
   /**
    * If true, will dispatch new event to the controller if generation increased since the last
    * processing, otherwise will process all events. See generation meta attribute <a
    * href="https://kubernetes.io/docs/tasks/access-kubernetes-api/custom-resources/custom-resource-definitions/#status-subresource">here</a>
+   *
+   * @return whether the controller takes generation into account to process events
    */
   boolean generationAwareEventProcessing() default true;
 

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

@@ -13,7 +13,8 @@ public interface ResourceController<R extends CustomResource> {
    * to have the implementation also idempotent, in the current implementation to cover all edge
    * cases actually will be executed mostly twice.
    *
-   * @param resource
+   * @param resource the resource that is marked for deletion
+   * @param context the context with which the operation is executed
    * @return {@link DeleteControl#DEFAULT_DELETE} - so the finalizer is automatically removed after
    *     the call. {@link DeleteControl#NO_FINALIZER_REMOVAL} if you don't want to remove the
    *     finalizer. Note that this is ALMOST NEVER the case.
@@ -27,6 +28,8 @@ default DeleteControl deleteResource(R resource, Context<R> context) {
    * object to make updates on custom resource if possible. Also always use the custom resource
    * parameter (not the custom resource that might be in the events)
    *
+   * @param resource the resource that has been created or updated
+   * @param context the context with which the operation is executed
    * @return The resource is updated in api server if the return value is not {@link
    *     UpdateControl#noUpdate()}. This the common use cases. However in cases, for example the
    *     operator is restarted, and we don't want to have an update call to k8s api to be made
@@ -39,7 +42,8 @@ default DeleteControl deleteResource(R resource, Context<R> context) {
   /**
    * In init typically you might want to register event sources.
    *
-   * @param eventSourceManager
+   * @param eventSourceManager the {@link EventSourceManager} which handles this controller and with
+   *     which event sources can be registered
    */
   default void init(EventSourceManager eventSourceManager) {}
 }

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

@@ -11,7 +11,7 @@ public interface EventSourceManager extends Closeable {
    *
    * @param name the name of the {@link EventSource} to add
    * @param eventSource the {@link EventSource} to register
-   * @thorw IllegalStateException if an {@link EventSource} with the same name is already
+   * @throws IllegalStateException if an {@link EventSource} with the same name is already
    *     registered.
    */
   void registerEventSource(String name, EventSource eventSource);