Add Javadoc to command-mode testing API

test-framework/junit5/src/main/java/io/quarkus/test/junit/QuarkusMainTestExtension.java

@@ -35,9 +35,6 @@
 public class QuarkusMainTestExtension extends AbstractJvmQuarkusTestExtension
         implements BeforeEachCallback, AfterEachCallback, ParameterResolver, BeforeAllCallback, AfterAllCallback {
 
-    public static final ExtensionContext.Namespace NAMESPACE = ExtensionContext.Namespace
-            .create("io.quarkus.test.main.jvm");
-
     PrepareResult prepareResult;
     private static boolean hasPerTestResources;
 

test-framework/junit5/src/main/java/io/quarkus/test/junit/main/Launch.java

@@ -6,8 +6,11 @@
 import java.lang.annotation.Target;
 
 /**
- * Annotation for {@link QuarkusMainTest} and {@link QuarkusMainIntegrationTest} used to
+ * Annotation for {@link QuarkusMainTest} and {@link QuarkusMainIntegrationTest} that is used to launch command line
+ * applications.
+ * The annotation is meant to be used on test methods only.
  *
+ * See also {@link LaunchResult} and {@link QuarkusMainLauncher}
  */
 @Target(ElementType.METHOD)
 @Retention(RetentionPolicy.RUNTIME)

test-framework/junit5/src/main/java/io/quarkus/test/junit/main/LaunchResult.java

@@ -2,6 +2,11 @@
 
 import java.util.List;
 
+/**
+ * Contains information about a run (via {@link Launch}) of a command line application.
+ * The class is meant to be used as a test method parameter giving the test the ability
+ * to assert various aspects of the run.
+ */
 public interface LaunchResult {
 
     default String getOutput() {
@@ -22,4 +27,4 @@ default void echoSystemOut() {
     List<String> getErrorStream();
 
     int exitCode();
-}
+}

test-framework/junit5/src/main/java/io/quarkus/test/junit/main/QuarkusMainLauncher.java

@@ -1,5 +1,11 @@
 package io.quarkus.test.junit.main;
 
+/**
+ * The annotation is meant to be used on test methods only and it allows the launching a command line application with
+ * arbitrary parameters.
+ *
+ * See also {@link LaunchResult} and {@link Launch}
+ */
 public interface QuarkusMainLauncher {
 
     LaunchResult launch(String... args);