GH-392 Document prototype design classes

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

Hide file tree

Showing 14 changed files with 42 additions and 2 deletions.
diff --git a/...work/src/main/java/org/panda_lang/framework/design/architecture/prototype/Adjustment.java b/...work/src/main/java/org/panda_lang/framework/design/architecture/prototype/Adjustment.java
@@ -18,6 +18,11 @@
 
 import org.panda_lang.framework.design.architecture.expression.Expression;
 
+/**
+ * Container for arguments adjusted to the property signature
+ *
+ * @param <T> generic type of property
+ */
 public interface Adjustment<T extends ExecutableProperty> {
 
     /**

diff --git a/...rk/src/main/java/org/panda_lang/framework/design/architecture/prototype/Constructors.java b/...rk/src/main/java/org/panda_lang/framework/design/architecture/prototype/Constructors.java
@@ -20,6 +20,9 @@
 
 import java.util.Optional;
 
+/**
+ * Container for constructors
+ */
 public interface Constructors extends Properties<PrototypeConstructor> {
 
     /**

diff --git a/...ramework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Fields.java b/...ramework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Fields.java
@@ -18,6 +18,9 @@
 
 import java.util.Optional;
 
+/**
+ * Container for fields
+ */
 public interface Fields extends Properties<PrototypeField> {
 
     /**

diff --git a/...amework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Methods.java b/...amework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Methods.java
@@ -20,6 +20,9 @@
 
 import java.util.Optional;
 
+/**
+ * Container for methods
+ */
 public interface Methods extends Properties<PrototypeMethod> {
 
     /**

diff --git a/...work/src/main/java/org/panda_lang/framework/design/architecture/prototype/Properties.java b/...work/src/main/java/org/panda_lang/framework/design/architecture/prototype/Properties.java
@@ -19,6 +19,11 @@
 import java.util.List;
 import java.util.function.Supplier;
 
+/**
+ * Represents container of executable properties
+ *
+ * @param <T> generic type of represented properties
+ */
 public interface Properties<T extends ExecutableProperty> {
 
     /**

diff --git a/...mework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Property.java b/...mework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Property.java
@@ -20,7 +20,7 @@
 import org.panda_lang.framework.design.interpreter.source.SourceLocation;
 
 /**
- * Element of property
+ * Element of prototype
  */
 public interface Property {
 

diff --git a/...k/src/main/java/org/panda_lang/framework/design/architecture/prototype/PropertyFrame.java b/...k/src/main/java/org/panda_lang/framework/design/architecture/prototype/PropertyFrame.java
@@ -18,6 +18,9 @@
 
 import org.panda_lang.framework.design.architecture.dynamic.Frame;
 
+/**
+ * Represents frames within the prototype frame (e.g. methods)
+ */
 public interface PropertyFrame extends Frame {
 
     /**

diff --git a/...c/main/java/org/panda_lang/framework/design/architecture/prototype/PropertyParameter.java b/...c/main/java/org/panda_lang/framework/design/architecture/prototype/PropertyParameter.java
@@ -18,6 +18,9 @@
 
 import org.panda_lang.framework.design.architecture.statement.Variable;
 
+/**
+ * Represents variable defined in the property signature - commonly called parameter
+ */
 public interface PropertyParameter extends Variable {
 
     /**

diff --git a/...ework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Prototype.java b/...ework/src/main/java/org/panda_lang/framework/design/architecture/prototype/Prototype.java
@@ -23,7 +23,7 @@
 import java.util.Optional;
 
 /**
- * Basic set of static data about a type
+ * Extensible owner of properties
  */
 public interface Prototype extends Property, Referencable {
 

diff --git a/...ain/java/org/panda_lang/framework/design/architecture/prototype/PrototypeConstructor.java b/...ain/java/org/panda_lang/framework/design/architecture/prototype/PrototypeConstructor.java
@@ -16,6 +16,9 @@
 
 package org.panda_lang.framework.design.architecture.prototype;
 
+/**
+ * Represents constructor property
+ */
 public interface PrototypeConstructor extends ExecutableProperty {
 
 }
diff --git a/.../src/main/java/org/panda_lang/framework/design/architecture/prototype/PrototypeField.java b/.../src/main/java/org/panda_lang/framework/design/architecture/prototype/PrototypeField.java
@@ -19,6 +19,9 @@
 import org.panda_lang.framework.design.architecture.statement.Variable;
 import org.panda_lang.framework.design.architecture.expression.Expression;
 
+/**
+ * Represents field property
+ */
 public interface PrototypeField extends ExecutableProperty, Variable {
 
     /**

diff --git a/...src/main/java/org/panda_lang/framework/design/architecture/prototype/PrototypeMethod.java b/...src/main/java/org/panda_lang/framework/design/architecture/prototype/PrototypeMethod.java
@@ -16,6 +16,9 @@
 
 package org.panda_lang.framework.design.architecture.prototype;
 
+/**
+ * Represents method property
+ */
 public interface PrototypeMethod extends ExecutableProperty {
 
     /**

diff --git a/...rk/src/main/java/org/panda_lang/framework/design/architecture/prototype/Referencable.java b/...rk/src/main/java/org/panda_lang/framework/design/architecture/prototype/Referencable.java
@@ -16,6 +16,9 @@
 
 package org.panda_lang.framework.design.architecture.prototype;
 
+/**
+ * Represent objects that can be reduced to the reference
+ */
 public interface Referencable {
 
     /**

diff --git a/.../java/org/panda_lang/framework/design/architecture/prototype/ReferenceFetchException.java b/.../java/org/panda_lang/framework/design/architecture/prototype/ReferenceFetchException.java
@@ -18,6 +18,9 @@
 
 import org.panda_lang.framework.language.runtime.PandaRuntimeException;
 
+/**
+ * Represents exceptions that may happen during the process of fetching a prototype
+ */
 public final class ReferenceFetchException extends PandaRuntimeException {
 
     public ReferenceFetchException(String message, Throwable cause) {