documentation fixes and diSPIM sync

src/main/java/org/micromanager/lightsheetmanager/api/AcquisitionManager.java

@@ -6,7 +6,8 @@ public interface AcquisitionManager {
 
     /**
      * Request that an acquisition is run.
-     * Returns a future tha can be gotton when acqusiiton is complete
+     *
+     * @return a future that completes when the acquisition finishes
      */
     Future<?> requestRun(boolean speedTest);
 

src/main/java/org/micromanager/lightsheetmanager/api/AcquisitionSettings.java

@@ -52,10 +52,12 @@ interface Builder<T extends Builder<T>>  {
          */
         DefaultAutofocusSettings.Builder autofocusBuilder();
 
-        // TODO: document this
         /**
+         * Returns this builder instance, cast to the concrete subtype.
+         * Used internally so that setter calls in the base builder return
+         * the concrete builder type for method chaining.
          *
-         * @return
+         * @return this builder, as {@code T}
          */
         T self();
 

src/main/java/org/micromanager/lightsheetmanager/api/AcquisitionSettingsDispim.java

@@ -126,7 +126,7 @@ public interface AcquisitionSettingsDispim extends AcquisitionSettings {
      *
      * @return the time point interval in seconds.
      */
-    int timePointInterval();
+    double timePointInterval();
 
     /**
      * Returns the post move delay in milliseconds.
@@ -209,7 +209,7 @@ interface Builder<T extends AcquisitionSettings.Builder<T>> extends AcquisitionS
          * @param timePointInterval the time point interval in seconds
          * @return {@code this} builder
          */
-        T timePointInterval(final int timePointInterval);
+        T timePointInterval(final double timePointInterval);
 
         /**
          * Sets the delay after a move when using multiple positions.

src/main/java/org/micromanager/lightsheetmanager/api/AutofocusSettings.java

@@ -16,9 +16,9 @@ public interface AutofocusSettings {
     Builder copyBuilder();
 
     /**
-     * Return true if channels are enabled.
+     * Returns true if autofocus is enabled.
      *
-     * @return true if channels are enabled
+     * @return true if autofocus is enabled
      */
     boolean enabled();
 
@@ -64,9 +64,9 @@ public interface AutofocusSettings {
     interface Builder {
 
         /**
-         * Return true if channels are enabled.
+         * Enable or disable autofocus.
          *
-         * @param state true if channels are enabled
+         * @param state true to enable autofocus
          */
         Builder enabled(final boolean state);
 

src/main/java/org/micromanager/lightsheetmanager/api/SheetCalibration.java

@@ -46,7 +46,7 @@ interface Builder {
         /**
          * Sets the width per pixel when isUsingAutoSheetWidth is true.
          *
-         * @param widthPerPixel TODO: units?
+         * @param widthPerPixel the width per pixel
          */
         Builder autoSheetWidthPerPixel(final double widthPerPixel);
 

src/main/java/org/micromanager/lightsheetmanager/api/StageScanSettings.java

@@ -17,9 +17,9 @@ public interface StageScanSettings {
     Builder copyBuilder();
 
     /**
-     * Returns true if the autofocus settings are enabled.
+     * Returns true if stage scanning is enabled.
      *
-     * @return true if the autofocus settings are enabled
+     * @return true if stage scanning is enabled
      */
     boolean enabled();
 
@@ -75,7 +75,7 @@ public interface StageScanSettings {
     interface Builder {
 
         /**
-         * Enable or disable the autofocus settings.
+         * Enable or disable stage scanning.
          *
          * @param state true to enable stage scanning
          * @return {@code this} builder
@@ -93,7 +93,7 @@ interface Builder {
         Builder accelerationFactor(final double factor);
 
         /**
-         * Sets the overshoot distance. // TODO: units
+         * Sets the overshoot distance.
          * <p>
          * The default value is 0.
          *

src/main/java/org/micromanager/lightsheetmanager/api/internal/BaseAcquisitionSettings.java

@@ -65,9 +65,9 @@ public T saveNamePrefix(final String name) {
         }
 
         /**
-         * Sets the folder name.
+         * Sets the plugin to save images during an acquisition.
          *
-         * @param state the name of the folder
+         * @param state true to save images during an acquisition
          */
         @Override
         public T saveImagesDuringAcquisition(final boolean state) {

src/main/java/org/micromanager/lightsheetmanager/api/internal/DispimAcquisitionSettings.java

@@ -36,7 +36,7 @@ public class DispimAcquisitionSettings extends BaseAcquisitionSettings implement
     private final boolean useAdvancedTiming_;
 
     private final int numTimePoints_;
-    private final int timePointInterval_;
+    private final double timePointInterval_;
     private final int postMoveDelay_;
 
     private final double liveScanPeriod_;
@@ -157,7 +157,7 @@ public int numTimePoints() {
     }
 
     @Override
-    public int timePointInterval() {
+    public double timePointInterval() {
         return timePointInterval_;
     }
 
@@ -256,7 +256,7 @@ public static class Builder
         private boolean useAdvancedTiming_ = false;
 
         private int numTimePoints_ = 1;
-        private int timePointInterval_ = 0;
+        private double timePointInterval_ = 0.0;
         private int postMoveDelay_ = 0;
 
         private double liveScanPeriod_ = 20.0; // TODO: this could go in user settings since it has to do with the live view
@@ -341,7 +341,7 @@ public Builder numTimePoints(final int numTimePoints) {
         }
 
         @Override
-        public Builder timePointInterval(final int timePointInterval) {
+        public Builder timePointInterval(final double timePointInterval) {
             timePointInterval_ = timePointInterval;
             return this;
         }