(no commit message)

[utils] / system / general / src / main / java / org / wamblee / system / graph / EdgeFactory.java

diff --git a/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java b/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java
index 32601e7f9b95114ee4dcd8bd7856127fe3bb3439..4ac39f6fdd07f08d499aa5f83a5bad66e433de80 100644 (file)
--- a/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java
+++ b/system/general/src/main/java/org/wamblee/system/graph/EdgeFactory.java
@@ -17,6 +17,18 @@ package org.wamblee.system.graph;
 
 import java.util.List;
 
+/**
+ * Edge factory used to extend a graph with new edges. 
+ * @author Erik Brakkee
+ *
+ * @param <NodeType> Type of node. 
+ */
 public interface EdgeFactory<NodeType extends Node> {
+    /**
+     * Computes a number of new edges to be added to the graph. 
+     * @param aFrom From node. 
+     * @param aTo To node. 
+     * @return List of edges from the from to the to node. 
+     */
     List<Edge> create(NodeType aFrom, NodeType aTo); 
 }