GH-652 - Polishing.

Author: odrotbohm

spring-modulith-core/src/main/java/org/springframework/modulith/core/ApplicationModuleDetectionStrategyLookup.java

@@ -70,9 +70,15 @@ class ApplicationModuleDetectionStrategyLookup {
 	 * Returns the {@link ApplicationModuleDetectionStrategy} to be used to detect {@link ApplicationModule}s. Will use
 	 * the following algorithm:
 	 * <ol>
-	 * <li>Use the prepared strategies if
+	 * <li>Use the prepared strategies if either {@code direct-sub-packages} or {@code explicitly-annotated} is configured
+	 * for the {@code spring.modulith.detection-strategy} configuration property.</li>
+	 * <li>Interpret the configured value as class if it doesn't match the predefined values just described.</li>
+	 * <li>Use the {@link ApplicationModuleDetectionStrategy} declared in {@code META-INF/spring.properties}
+	 * (deprecated)</li>
+	 * <li>A final fallback on the {@code direct-sub-packages}.</li>
+	 * </ol>
 	 *
-	 * @return
+	 * @return will never be {@literal null}.
 	 */
 	static ApplicationModuleDetectionStrategy getStrategy() {
 

src/docs/antora/modules/ROOT/pages/appendix.adoc

@@ -13,6 +13,11 @@
 |`true`
 |Whether to configure defaults for the async processing termination, namely to wait for task completion for 2 seconds. See `TaskExecutionProperties` for details.
 
+|`spring.modulith.detection-strategy`
+|none
+|The strategy to be applied to detect application modules.
+Can either be the class name of a custom implementation of `ApplicationModuleDetectionStrategy` or `direct-subpackages` (which is also the final fallback if nothing is configured) or `explicitly-annotated` to only select packages explicitly annotated with `@ApplicationModule` or jMolecules' `@Module`. See xref:fundamentals.adoc#customizing-modules[Customize Application Module Detection] for details.
+
 |`spring.modulith.events.externalization.enabled`
 |`true`
 |Whether to enable event externalization.