JAL-2388 Tidies

[jalview.git] / src / jalview / gui / OverviewCanvas.java

diff --git a/src/jalview/gui/OverviewCanvas.java b/src/jalview/gui/OverviewCanvas.java
index e4c2056..5005f4e 100644 (file)
--- a/src/jalview/gui/OverviewCanvas.java
+++ b/src/jalview/gui/OverviewCanvas.java
@@ -31,7 +31,6 @@ import java.awt.image.BufferedImage;
 
 import javax.swing.JComponent;
 
-
 public class OverviewCanvas extends JComponent
 {
   private static final Color TRANS_GREY = new Color(100, 100, 100, 25);
@@ -52,9 +51,9 @@ public class OverviewCanvas extends JComponent
 
   private jalview.renderer.seqfeatures.FeatureRenderer fr;
 
-  OverviewDimensions od;
+  private OverviewDimensions od;
 
-  AlignViewportI av;
+  private AlignViewportI av;
 
   public OverviewCanvas(OverviewDimensions overviewDims,
           AlignViewportI alignvp)
@@ -68,14 +67,20 @@ public class OverviewCanvas extends JComponent
     fr = new jalview.renderer.seqfeatures.FeatureRenderer(av);
   }
 
+  /**
+   * Update the overview dimensions object used by the canvas (e.g. if we change
+   * from showing hidden columns to hiding them or vice versa)
+   * 
+   * @param overviewDims
+   */
   public void resetOviewDims(OverviewDimensions overviewDims)
   {
     od = overviewDims;
   }
 
-  /*
-   * Signals to drawing code that the associated alignment viewport
-   * has changed and a redraw will be required
+  /**
+   * Signals to drawing code that the associated alignment viewport has changed
+   * and a redraw will be required
    */
   public boolean restartDraw()
   {
@@ -93,6 +98,16 @@ public class OverviewCanvas extends JComponent
     }
   }
 
+  /**
+   * Draw the overview sequences
+   * 
+   * @param showSequenceFeatures
+   *          true if sequence features are to be shown
+   * @param showAnnotation
+   *          true if the annotation is to be shown
+   * @param transferRenderer
+   *          the renderer to transfer feature colouring from
+   */
   public void draw(boolean showSequenceFeatures, boolean showAnnotation,
           FeatureRenderer transferRenderer)
   {