From 9d267b693471969c892ecaa79f1832ceefe90b90 Mon Sep 17 00:00:00 2001
From: Eduwer Camacaro <eduwerc@gmail.com>
Date: Fri, 20 Dec 2024 09:00:48 -0500
Subject: [PATCH] LHTest java doc

---
 .../src/main/java/io/littlehorse/test/LHTest.java | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/test-utils/src/main/java/io/littlehorse/test/LHTest.java b/test-utils/src/main/java/io/littlehorse/test/LHTest.java
index f6bbd75b7..5ef9c58fa 100644
--- a/test-utils/src/main/java/io/littlehorse/test/LHTest.java
+++ b/test-utils/src/main/java/io/littlehorse/test/LHTest.java
@@ -6,6 +6,21 @@
 import java.lang.annotation.Target;
 import org.junit.jupiter.api.extension.ExtendWith;
 
+/**
+ * {@code @LHTest} identifies test classes and methods that run a Littlehorse workflow.
+ * This annotation will spin up a Littlehorse cluster using the "bootstrapper.class" configuration.
+ * It can be used at test class level or method level:
+ * <blockquote><pre>
+ *  {@code @LHTest}
+ *  class MyTest {
+ *      {@code @LHTest}
+ *      void myTestMethod() {
+ *      }
+ *  }
+ * </pre></blockquote>
+ *
+ *
+ */
 @Target({ElementType.TYPE, ElementType.METHOD})
 @Retention(RetentionPolicy.RUNTIME)
 @ExtendWith(LHExtension.class)