GH-21 - A bit more Javadoc in the example module.

Author: odrotbohm

spring-modulith-example/src/main/java/example/inventory/InventoryInternal.java

@@ -18,6 +18,9 @@
 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

spring-modulith-example/src/main/java/example/inventory/InventoryManagement.java

@@ -24,6 +24,8 @@
 import org.springframework.transaction.event.TransactionalEventListener;
 
 /**
+ * A Spring {@link Service} exposed by the inventory module.
+ *
  * @author Oliver Drotbohm
  */
 @Slf4j

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;

spring-modulith-example/src/main/java/example/order/internal/OrderInternal.java

@@ -18,6 +18,8 @@
 import org.springframework.stereotype.Component;
 
 /**
+ * Some order-internal application component.
+ *
  * @author Oliver Drotbohm
  */
 @Component

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;