Added comments to the module-info.java files

Articdive · Nov 10, 2023 · 307abb0 · 307abb0
1 parent 90d96ba
commit 307abb0
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 1 deletion.
diff --git a/core/src/main/java/module-info.java b/core/src/main/java/module-info.java
@@ -1,3 +1,8 @@
+/**
+ * The core JNoise module. 
+ * 
+ * Requires JSpecify.
+ */
 module de.articdive.jnoise.core {
   exports de.articdive.jnoise.core.api.functions;
   exports de.articdive.jnoise.core.api.modifiers;

diff --git a/generators/src/main/java/module-info.java b/generators/src/main/java/module-info.java
@@ -1,3 +1,8 @@
+/**
+ * The "generators" JNoise module. 
+ * 
+ * Requires the core JNoise module.
+ */
 module de.articdive.jnoise.generators {
   exports de.articdive.jnoise.generators.noise_parameters.distance_functions;
   exports de.articdive.jnoise.generators.noise_parameters.fade_functions;

diff --git a/modifiers/src/main/java/module-info.java b/modifiers/src/main/java/module-info.java
@@ -1,3 +1,8 @@
+/**
+ * The "modifiers" JNoise module. 
+ * 
+ * Requires the core JNoise module.
+ */
 module de.articdive.jnoise.modifiers {
   exports de.articdive.jnoise.modifiers.absolute_value;
   exports de.articdive.jnoise.modifiers.clamp;

diff --git a/modules/src/main/java/module-info.java b/modules/src/main/java/module-info.java
@@ -1,3 +1,8 @@
+/**
+ * The "modules" JNoise module. 
+ * 
+ * Requires the core JNoise module.
+ */
 module de.articdive.jnoise.modules {
   exports de.articdive.jnoise.modules.blend;
   exports de.articdive.jnoise.modules.combination;

diff --git a/pipeline/src/main/java/module-info.java b/pipeline/src/main/java/module-info.java
@@ -1,4 +1,10 @@
-module de.articdive.jnoise.pipelines {
+/**
+ * The "pipeline" JNoise module. 
+ * 
+ * Requires the "core", "transformers", "generators", 
+ * "modules" and "modifiers" JNoise module.
+ */
+module de.articdive.jnoise.pipeline {
   exports de.articdive.jnoise.pipeline;
 
   requires transitive de.articdive.jnoise.core;

diff --git a/transformers/src/main/java/module-info.java b/transformers/src/main/java/module-info.java
@@ -1,3 +1,8 @@
+/**
+ * The "transformers" JNoise module. 
+ * 
+ * Requires the core JNoise module.
+ */
 module de.articdive.jnoise.transformers {
   exports de.articdive.jnoise.transformers.domain_warp;
   exports de.articdive.jnoise.transformers.scale;