improve documentation, closed #587

It is not possible to merge test-support with test-spi-support because of circular dependencies (e.g. "spi" requires "WithTimeZone").
hosh-shell · Dec 23, 2023 · 7028af1 · 7028af1
1 parent f8ffff4
commit 7028af1
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 1 deletion.
diff --git a/spi-test-support/src/main/java/module-info.java b/spi-test-support/src/main/java/module-info.java
@@ -21,10 +21,12 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+/**
+ * This module contains helpers specifically designed for spi classes.
+ */
 module hosh.spi.test.support {
 	requires hosh.spi;
 
 	requires org.assertj.core;
 	requires org.mockito;
-
 }
diff --git a/test-support/src/main/java/module-info.java b/test-support/src/main/java/module-info.java
@@ -21,6 +21,11 @@
  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  * SOFTWARE.
  */
+
+/**
+ * This module contains generic test helpers to be used by any modules (including spi).
+ * So, it cannot depend on spi classes.
+ */
 module hosh.test.support {
 	requires java.logging;