Eren Yilmaz 7 rokov pred
rodič
commit
388d20a094

+ 4 - 0
src/Main.java

@@ -12,6 +12,10 @@ import view.MainView;
  */
 public class Main {
 
+    /**
+     * Will be run when the application is started.
+     * @param args the command line arguments, currently not in use
+     */
 	public static void main(String[] args) {
 		Reader r = new Reader( "papergraph.json" );
 		LayeredGraphNode graph = r.readInputGraph();

+ 4 - 1
src/algorithms/SweepCrossingMinimizer.java

@@ -14,7 +14,10 @@ import model.LayeredGraphNode;
  */
 public class SweepCrossingMinimizer {
 
-    
+    /**
+     * minimizes crossings by sweeping multiple times and locally reducing crossings between pairs of layers
+     * @param graph the graph where the crossings should be minimized.
+     */
     public void minimizeCrossings( LayeredGraphNode graph ) {
         ArrayList< ArrayList< LayeredGraphNode > > layers = graph.getContainedLayers();
         System.out.println( "Number of Detected Crossings before minimization: " + numberOfCrossings( layers ) );

+ 4 - 0
src/algorithms/animated/bk/Compaction.java

@@ -45,6 +45,10 @@ public class Compaction implements AlgorithmStage{
 		actions = new ArrayList<>();
 	}
 	
+	/**
+	 * calculates the minimum spacing needed between two left borders of nodes.
+	 * @return the spacing
+	 */
 	public double calcSpacing()
 	{
 		double max = 0;

+ 1 - 1
src/model/LayeredEdge.java

@@ -9,7 +9,7 @@ import algorithms.animated.bk.ExtremalLayoutCalc.LayoutType;
 
 /**
  * Die Implementation einer Kante aus einem Layered Graphen.
- * Implementiert {@link LayeredGraphEdge.}
+ * Implementiert {@link LayeredGraphEdge}.
  * 
  * @author kolja
  *

+ 2 - 2
src/model/LayeredGraphNode.java

@@ -209,8 +209,8 @@ public interface LayeredGraphNode {
     /**
      * F�gt eine neue Kante zum Subgraph hinzu
      * @param original Die Originale Elk Kante
-     * @param sources Der Startknoten
-     * @param targets Der Endknoten
+     * @param source Der Startknoten
+     * @param target Der Endknoten
      * @return Die neue Kante
      */
     LayeredGraphEdge createSimpleEdge( ElkEdge original, LayeredGraphNode source, LayeredGraphNode target );

+ 1 - 1
src/model/LayeredNode.java

@@ -13,7 +13,7 @@ import view.MainView;
 
 /**
  * Die Implementation eines Knotens in einem Layered Graph.
- * Implementiert {@link LayeredGraphNode.}
+ * Implementiert {@link LayeredGraphNode}.
  * 
  * @author kolja
  *