New annotation and changes

src/mandelbrot/DimensionFrame.java

@@ -4,20 +4,39 @@
 import java.awt.*;
 import java.util.ArrayList;
 
+/**
+ * Secondary JFrame that allows for the user to be able to find the estimated fractal dimension of a fractal.
+ * This object uses the box counting method to find the approximate Minkowski–Bouligand dimension of the boundary.
+ * As well as this, it graphically shows the user what is happening on each iteration of the box counting method.
+ * The more self similar the fractal, the higher the expected fractal dimension.
+ */
+
 public class DimensionFrame extends JFrame {
 
-    FractalSet fractalSet;
+    /**The fractal set to be measured*/
+    private FractalSet fractalSet;
+
+    /**Graphical component to display gridlines*/
+    private GridArgandDiagram argandDiagram;
+
+    private Dimension screensize;
 
-    GridArgandDiagram argandDiagram;
+    /**The current step of the iteration*/
+    private int iteration;
 
-    Dimension screensize;
+    /**The initial side length of the drawn boxes*/
+    private int initialLength;
 
-    int iteration;
-    int initialStep;
-    int boxes;
+    /*The total number of boxes counted in each iteration**/
+    private int boxes;
+
+    /**Array of log(N) where N is number of boxes*/
     double[] logOfNoBoxes;
+
+    /**Array of log(1/ε) where ε is box side length*/
     double[] logOfSideLengths;
 
+    /**Constucts a DimensionFrame that initially just displays the selected fractal*/
     public DimensionFrame(FractalSet fractalSet, FractalColours colours, DrawingConditions conditions) {
 
         super("Box Counting Calculator");
@@ -31,12 +50,12 @@ public DimensionFrame(FractalSet fractalSet, FractalColours colours, DrawingCond
 
         this.fractalSet = fractalSet;
         this.iteration = 0;
-        this.initialStep = 512;
+        this.initialLength = 512;
         this.boxes = 0;
 
         setupComponents(colours, conditions);
 
-        int size = (int)((Math.log(initialStep)/Math.log(2)) - 1);
+        int size = (int)((Math.log(initialLength)/Math.log(2)) - 1);
         this.logOfNoBoxes = new double[size];
         this.logOfSideLengths = new double[size];
 
@@ -48,6 +67,7 @@ public DimensionFrame(FractalSet fractalSet, FractalColours colours, DrawingCond
 
     }
 
+    /**Sets up the components of this object*/
     public void setupComponents(FractalColours colours, DrawingConditions conditions) {
 
         if (fractalSet.getType() == FractalType.MANDELBROT) conditions.drawJulia = false;
@@ -57,39 +77,41 @@ public void setupComponents(FractalColours colours, DrawingConditions conditions
         conditions.readyToDrawCoords = false;
         conditions.readyToDrawInfo = false;
 
-        this.argandDiagram = new GridArgandDiagram(this, fractalSet, conditions, colours, screensize, initialStep);
+        this.argandDiagram = new GridArgandDiagram(this, fractalSet, conditions, colours, screensize, initialLength);
 
         this.add(argandDiagram);
         this.pack();
 
     }
 
+    /**Draws the next iteration of gridlines by halving box side length*/
     public void updateGridlines() {
 
         if (!argandDiagram.finished) {
             iteration++;
-            argandDiagram.currentStep /= 2;
+            argandDiagram.currentLength /= 2;
             argandDiagram.start = true;
             updateGrids();
             logOfNoBoxes[iteration - 1] = Math.log(boxes);
-            logOfSideLengths[iteration - 1] = Math.log(1.0 / argandDiagram.currentStep);
+            logOfSideLengths[iteration - 1] = Math.log(1.0 / argandDiagram.currentLength);
         }
         argandDiagram.repaint();
 
     }
 
+    /**Counts the number of grids that cover the boundary of the fractal and queues them for drawing*/
     public void updateGrids() {
 
         boxes = 0;
-        for (int y = 0; y < argandDiagram.getHeight(); y += argandDiagram.currentStep - 1) {
+        for (int y = 0; y < argandDiagram.getHeight(); y += argandDiagram.currentLength - 1) {
 
-            for (int x = 0; x < argandDiagram.getWidth(); x += argandDiagram.currentStep - 1) {
+            for (int x = 0; x < argandDiagram.getWidth(); x += argandDiagram.currentLength - 1) {
 
                 boolean found = false;
 
-                for (int boxY = y; boxY <= y + argandDiagram.currentStep - 1 && boxY < argandDiagram.getHeight() && !found; boxY++) {
+                for (int boxY = y; boxY <= y + argandDiagram.currentLength - 1 && boxY < argandDiagram.getHeight() && !found; boxY++) {
 
-                    for (int boxX = x; boxX <= x + argandDiagram.currentStep - 1 && boxX < argandDiagram.getWidth() && !found; boxX++) {
+                    for (int boxX = x; boxX <= x + argandDiagram.currentLength - 1 && boxX < argandDiagram.getWidth() && !found; boxX++) {
 
                         if (argandDiagram.getColorAtPixel(boxX, boxY).equals(argandDiagram.colours.getInner()))  {
 

src/mandelbrot/DrawingConditions.java

@@ -23,6 +23,7 @@ public DrawingConditions() {
 
     }
 
+    /**Clones the current object and outputs it to separate references*/
     public DrawingConditions clone() {
 
         DrawingConditions clone = new DrawingConditions();

src/mandelbrot/FractalColours.java

@@ -80,7 +80,7 @@ public Color getInner() {
     public void setInner(Color inner) {
 
         this.inner = inner;
-        this.invertColour(inner);
+        invertColour(inner);
 
     }
 

src/mandelbrot/FractalSet.java

@@ -37,6 +37,7 @@ public interface FractalSet {
 
     FractalType getType();
 
+    /**Clones the fractal set to separate reference*/
     FractalSet clone();
 
     void setAllValues(FractalDataSerializable fractalData);