diff --git a/spring-modulith-example/src/main/java/example/inventory/InventoryInternal.java b/spring-modulith-example/src/main/java/example/inventory/InventoryInternal.java index 6190b9c3..ca14b1c0 100644 --- a/spring-modulith-example/src/main/java/example/inventory/InventoryInternal.java +++ b/spring-modulith-example/src/main/java/example/inventory/InventoryInternal.java @@ -18,6 +18,9 @@ package example.inventory; import org.springframework.stereotype.Component; /** + * Some inventory-internal application component. As it is located in the very same package, it can be protected from + * access by other modules by using the default visibility instead of making it public. + * * @author Oliver Drotbohm */ @Component diff --git a/spring-modulith-example/src/main/java/example/inventory/InventoryManagement.java b/spring-modulith-example/src/main/java/example/inventory/InventoryManagement.java index 7c0e6973..6d301534 100644 --- a/spring-modulith-example/src/main/java/example/inventory/InventoryManagement.java +++ b/spring-modulith-example/src/main/java/example/inventory/InventoryManagement.java @@ -24,6 +24,8 @@ import org.springframework.stereotype.Service; import org.springframework.transaction.event.TransactionalEventListener; /** + * A Spring {@link Service} exposed by the inventory module. + * * @author Oliver Drotbohm */ @Slf4j diff --git a/spring-modulith-example/src/main/java/example/inventory/package-info.java b/spring-modulith-example/src/main/java/example/inventory/package-info.java new file mode 100644 index 00000000..548d9a37 --- /dev/null +++ b/spring-modulith-example/src/main/java/example/inventory/package-info.java @@ -0,0 +1,7 @@ +/** + * The logical application module inventory implemented as a single-package module. Allows to hide application + * components inside the module by using package scoped types. + * + * @see example.inventory.InventoryInternal + */ +package example.inventory; diff --git a/spring-modulith-example/src/main/java/example/order/internal/OrderInternal.java b/spring-modulith-example/src/main/java/example/order/internal/OrderInternal.java index 72640fab..215521cd 100644 --- a/spring-modulith-example/src/main/java/example/order/internal/OrderInternal.java +++ b/spring-modulith-example/src/main/java/example/order/internal/OrderInternal.java @@ -18,6 +18,8 @@ package example.order.internal; import org.springframework.stereotype.Component; /** + * Some order-internal application component. + * * @author Oliver Drotbohm */ @Component diff --git a/spring-modulith-example/src/main/java/example/order/package-info.java b/spring-modulith-example/src/main/java/example/order/package-info.java new file mode 100644 index 00000000..69be6a96 --- /dev/null +++ b/spring-modulith-example/src/main/java/example/order/package-info.java @@ -0,0 +1,7 @@ +/** + * The logical application module order implemented as a multi-package module. Internal components located in nested + * packages are prevented from being accessed by the {@link org.springframework.modulith.model.ApplicationModules} type. + * + * @see example.ModularityTests + */ +package example.order;