From dc7d6a32d10477ce5c4e563e2884b957f976df27 Mon Sep 17 00:00:00 2001
From: csviri <csviri@gmail.com>
Date: Mon, 19 Sep 2022 13:07:13 +0200
Subject: [PATCH] docs: javadoc for CRUDNoGCKubernetesDependentResource

---
 .../kubernetes/CRUDKubernetesDependentResource.java   |  5 ++---
 .../CRUDNoGCKubernetesDependentResource.java          | 11 +++++++++++
 2 files changed, 13 insertions(+), 3 deletions(-)

diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java
index 9440898d2f..5b0a1c3235 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDKubernetesDependentResource.java
+++ b/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
diff --git a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDNoGCKubernetesDependentResource.java b/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDNoGCKubernetesDependentResource.java
index b9da7023b0..f1e83ff1b1 100644
--- a/operator-framework-core/src/main/java/io/javaoperatorsdk/operator/processing/dependent/kubernetes/CRUDNoGCKubernetesDependentResource.java
+++ b/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>