Add Javadoc

Author: marcphilipp

junit-platform-launcher/src/main/java/org/junit/platform/launcher/core/LauncherDiscoveryRequestBuilder.java

@@ -11,6 +11,7 @@
 package org.junit.platform.launcher.core;
 
 import static org.apiguardian.api.API.Status.DEPRECATED;
+import static org.apiguardian.api.API.Status.EXPERIMENTAL;
 import static org.apiguardian.api.API.Status.STABLE;
 import static org.junit.platform.launcher.LauncherConstants.OUTPUT_DIR_PROPERTY_NAME;
 
@@ -30,6 +31,7 @@
 import org.junit.platform.engine.Filter;
 import org.junit.platform.engine.reporting.OutputDirectoryProvider;
 import org.junit.platform.launcher.EngineFilter;
+import org.junit.platform.launcher.LauncherConstants;
 import org.junit.platform.launcher.LauncherDiscoveryListener;
 import org.junit.platform.launcher.LauncherDiscoveryRequest;
 import org.junit.platform.launcher.PostDiscoveryFilter;
@@ -287,6 +289,21 @@ public LauncherDiscoveryRequestBuilder listeners(LauncherDiscoveryListener... li
 		return this;
 	}
 
+	/**
+	 * Set the {@link OutputDirectoryProvider} to use for the request.
+	 *
+	 * <p>If not specified, a default provider will be used that can be
+	 * configured via the {@value LauncherConstants#OUTPUT_DIR_PROPERTY_NAME}
+	 * configuration parameter.
+	 *
+	 * @param outputDirectoryProvider the output directory provider to use;
+	 *                                never {@code null}
+	 * @return this builder for method chaining
+	 * @since 1.12
+	 * @see OutputDirectoryProvider
+	 * @see LauncherConstants#OUTPUT_DIR_PROPERTY_NAME
+	 */
+	@API(status = EXPERIMENTAL, since = "1.12")
 	public LauncherDiscoveryRequestBuilder outputDirectoryProvider(OutputDirectoryProvider outputDirectoryProvider) {
 		this.outputDirectoryProvider = Preconditions.notNull(outputDirectoryProvider,
 			"outputDirectoryProvider must not be null");

junit-platform-testkit/src/main/java/org/junit/platform/testkit/engine/EngineTestKit.java

@@ -427,6 +427,19 @@ public Builder enableImplicitConfigurationParameters(boolean enabled) {
 			return this;
 		}
 
+		/**
+		 * Set the {@link OutputDirectoryProvider} to use.
+		 *
+		 * <p>If not specified, a default provider will be used that throws an
+		 * exception when attempting to create output directories. This is done
+		 * to avoid accidentally writing output files to the file system.
+		 *
+		 * @param outputDirectoryProvider the output directory provider to use;
+		 *                                never {@code null}
+		 * @return this builder for method chaining
+		 * @since 1.12
+		 * @see OutputDirectoryProvider
+		 */
 		@API(status = EXPERIMENTAL, since = "1.12")
 		public Builder outputDirectoryProvider(OutputDirectoryProvider outputDirectoryProvider) {
 			this.requestBuilder.outputDirectoryProvider(outputDirectoryProvider);