GH-392 Document the module design classes

panda-lang · Nov 1, 2019 · ea4b69c · ea4b69c
1 parent 5df308d
commit ea4b69c
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 5 deletions.
diff --git a/...-framework/src/main/java/org/panda_lang/framework/design/architecture/module/Imports.java b/...-framework/src/main/java/org/panda_lang/framework/design/architecture/module/Imports.java
@@ -18,6 +18,9 @@
 
 import org.panda_lang.framework.design.architecture.prototype.Reference;
 
+/**
+ * Represents references imported in the specific space, e.g. file
+ */
 public interface Imports extends ModuleResource {
 
     /**

diff --git a/...a-framework/src/main/java/org/panda_lang/framework/design/architecture/module/Module.java b/...a-framework/src/main/java/org/panda_lang/framework/design/architecture/module/Module.java
@@ -23,6 +23,9 @@
 import java.util.Map.Entry;
 import java.util.Optional;
 
+/**
+ * Identifiable container of resources
+ */
 public interface Module extends Modules, ModuleResource {
 
     /**

diff --git a/...amework/src/main/java/org/panda_lang/framework/design/architecture/module/ModulePath.java b/...amework/src/main/java/org/panda_lang/framework/design/architecture/module/ModulePath.java
@@ -21,6 +21,12 @@
  */
 public interface ModulePath extends Modules {
 
-    void include(String name, Runnable initialize);
+    /**
+     * Include initializer for the specified module
+     *
+     * @param name name of module
+     * @param initializer module initializer
+     */
+    void include(String name, Runnable initializer);
 
 }
diff --git a/...ork/src/main/java/org/panda_lang/framework/design/architecture/module/ModuleResource.java b/...ork/src/main/java/org/panda_lang/framework/design/architecture/module/ModuleResource.java
@@ -20,6 +20,9 @@
 
 import java.util.Optional;
 
+/**
+ * References container
+ */
 public interface ModuleResource {
 
     /**

diff --git a/...-framework/src/main/java/org/panda_lang/framework/design/architecture/module/Modules.java b/...-framework/src/main/java/org/panda_lang/framework/design/architecture/module/Modules.java
@@ -21,6 +21,9 @@
 import java.util.Collection;
 import java.util.Optional;
 
+/**
+ * Modules container
+ */
 public interface Modules {
 
     /**

diff --git a/.../src/main/java/org/panda_lang/framework/language/architecture/module/PandaModulePath.java b/.../src/main/java/org/panda_lang/framework/language/architecture/module/PandaModulePath.java
@@ -34,19 +34,19 @@ public PandaModulePath(Module... modules) {
     }
 
     @Override
-    public void include(String name, Runnable initialize) {
+    public void include(String name, Runnable initializer) {
         Runnable cachedInitialize = modules.get(name);
 
         if (cachedInitialize != null) {
-            Runnable nextInitialize = initialize;
+            Runnable nextInitialize = initializer;
 
-            initialize = () -> {
+            initializer = () -> {
                 cachedInitialize.run();
                 nextInitialize.run();
             };
         }
 
-        modules.put(name, initialize);
+        modules.put(name, initializer);
     }
 
     @Override