docs: javadoc for CRUDNoGCKubernetesDependentResource (#1483)

Author: csviri

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java

@@ -7,9 +7,8 @@
 import io.javaoperatorsdk.operator.processing.dependent.Updater;
 
 /**
- * Adaptor class for standalone mode for resources that manage Create, Read and Update operations
- * and that should be automatically garbage-collected by Kubernetes when the associated primary
- * resource is destroyed.
+ * Adaptor class resources that manage Create, Read and Update operations and that should be
+ * automatically garbage-collected by Kubernetes when the associated primary resource is destroyed.
  *
  * @param <R> the type of the managed dependent resource
  * @param <P> the type of the associated primary resource

operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDNoGCKubernetesDependentResource.java

@@ -6,6 +6,17 @@
 import io.javaoperatorsdk.operator.processing.dependent.Creator;
 import io.javaoperatorsdk.operator.processing.dependent.Updater;
 
+/**
+ *
+ * Adaptor class resources that manage Create, Read and Update operations, however resource is NOT
+ * garbage collected by Kubernetes when the associated primary resource is destroyed, instead
+ * explicitly deleted. This is useful when resource needs to be deleted before another one in a
+ * workflow, in other words an ordering matters during a cleanup. See also:
+ * <a href="https://github.com/java-operator-sdk/java-operator-sdk/issues/1127">Related issue</a>
+ *
+ * @param <R> the type of the managed dependent resource
+ * @param <P> the type of the associated primary resource
+ */
 @Ignore
 public class CRUDNoGCKubernetesDependentResource<R extends HasMetadata, P extends HasMetadata>
     extends KubernetesDependentResource<R, P>