From d5c6550e9f52e84b7b7f3fcd987120d4c85a7bc5 Mon Sep 17 00:00:00 2001
From: Nicolas Filotto <nfilotto@talend.com>
Date: Thu, 2 May 2024 15:18:52 +0200
Subject: [PATCH] Improve Javadoc

---
 .../karaf/camel/itests/PaxExamWithExternalResource.java      | 5 +++++
 .../karaf/camel/itests/UseExternalResourceProvider.java      | 3 ++-
 2 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/PaxExamWithExternalResource.java b/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/PaxExamWithExternalResource.java
index 16e05416c..98da1653e 100644
--- a/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/PaxExamWithExternalResource.java
+++ b/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/PaxExamWithExternalResource.java
@@ -43,6 +43,11 @@
 
 /**
  * A fork of {@link PaxExam} that supports external resources which can be created and destroyed outside Karaf.
+ * <p>
+ * This runner is intended to be used with {@link UseExternalResourceProvider} annotation in order to create the
+ * external resources that are needed by the test. Please note that due to the way PaxExam works, the class cannot be
+ * the same as the test class, but it can be a static inner class of it otherwise the class will need to be resolved
+ * within Karaf which is what we want to avoid.
  */
 public class PaxExamWithExternalResource extends Runner implements Filterable, Sortable {
     private static final Logger LOG = LoggerFactory.getLogger(PaxExamWithExternalResource.class);
diff --git a/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/UseExternalResourceProvider.java b/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/UseExternalResourceProvider.java
index e907dfa5e..b9795bb01 100644
--- a/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/UseExternalResourceProvider.java
+++ b/tests/camel-integration-test/src/main/java/org/apache/karaf/camel/itests/UseExternalResourceProvider.java
@@ -10,7 +10,8 @@
  * Annotation to specify the class that provides the methods to create all the external resources required by the test.
  * In the provider class, each public static method that returns an instance of a subtype of {@link ExternalResource}
  * with no parameters is considered as an {@link ExternalResource} supplier, so it will be invoked before executing
- * the test and {@code PaxExamWithExternalResource} will ensure that t.
+ * the test and {@code PaxExamWithExternalResource} will take care of its lifecycle making sure that it is created and
+ * destroyed outside Karaf.
  *
  * @see PaxExamWithExternalResource
  */