4.x: Add more javadoc for AddConfigBlock annotations (helidon-io#9697) (

helidon-io#9761)
spericas · Feb 11, 2025 · 759794a · 759794a
1 parent 2be95bd
commit 759794a
Show file tree

Hide file tree

Showing 3 changed files with 45 additions and 3 deletions.
diff --git a/...e/testing/junit5/src/main/java/io/helidon/microprofile/testing/junit5/AddConfigBlock.java b/...e/testing/junit5/src/main/java/io/helidon/microprofile/testing/junit5/AddConfigBlock.java
@@ -25,6 +25,20 @@
 /**
  * Add a configuration fragment to the {@link Configuration#useExisting() synthetic test configuration}.
  * <p>
+ * Example:
+ * <pre>
+ *  &#64;AddConfigBlock(type = "yaml", value = """
+ *      foo1:
+ *        bar: "value1"
+ *  """)
+ *  &#64;AddConfigBlock(type = "properties", value = """
+ *       foo2=value2
+ *       foo3=value3
+ *  """)
+ *  class MyTest {
+ *  }
+ * </pre>
+ * <p>
  * This annotation can be repeated.
  * <p>
  * If used on a method, the container will be reset regardless of the test lifecycle.
@@ -40,7 +54,7 @@
 @Deprecated(since = "4.2.0")
 public @interface AddConfigBlock {
     /**
-     * Specifies the configuration format.
+     * Specifies the configuration format. Possible values are: 'yaml' and `properties`.
      * <p>
      * The default format is 'properties'
      *

diff --git a/...profile/testing/testing/src/main/java/io/helidon/microprofile/testing/AddConfigBlock.java b/...profile/testing/testing/src/main/java/io/helidon/microprofile/testing/AddConfigBlock.java
@@ -26,6 +26,20 @@
 /**
  * Add a configuration fragment to the {@link Configuration#useExisting() synthetic test configuration}.
  * <p>
+ * Example:
+ * <pre>
+ *  &#64;AddConfigBlock(type = "yaml", value = """
+ *      foo1:
+ *        bar: "value1"
+ *  """)
+ *  &#64;AddConfigBlock(type = "properties", value = """
+ *       foo2=value2
+ *       foo3=value3
+ *  """)
+ *  class MyTest {
+ *  }
+ * </pre>
+ * <p>
  * This annotation can be repeated.
  * <p>
  * If used on a method, the container will be reset regardless of the test lifecycle.
@@ -40,7 +54,7 @@
 @Repeatable(AddConfigBlocks.class)
 public @interface AddConfigBlock {
     /**
-     * Specifies the configuration format.
+     * Specifies the configuration format. Possible values are: 'yaml' and `properties`.
      * <p>
      * The default format is 'properties'
      *

diff --git a/...e/testing/testng/src/main/java/io/helidon/microprofile/testing/testng/AddConfigBlock.java b/...e/testing/testng/src/main/java/io/helidon/microprofile/testing/testng/AddConfigBlock.java
@@ -25,6 +25,20 @@
 /**
  * Add a configuration fragment to the {@link Configuration#useExisting() synthetic test configuration}.
  * <p>
+ * Example:
+ * <pre>
+ *  &#64;AddConfigBlock(type = "yaml", value = """
+ *      foo1:
+ *        bar: "value1"
+ *  """)
+ *  &#64;AddConfigBlock(type = "properties", value = """
+ *       foo2=value2
+ *       foo3=value3
+ *  """)
+ *  class MyTest {
+ *  }
+ * </pre>
+ * <p>
  * This annotation can be repeated.
  * <p>
  * If used on a method, the container will be reset regardless of the test lifecycle.
@@ -40,7 +54,7 @@
 @Deprecated(since = "4.2.0")
 public @interface AddConfigBlock {
     /**
-     * Specifies the configuration format.
+     * Specifies the configuration format. Possible values are: 'yaml' and `properties`.
      * <p>
      * The default format is 'properties'
      *