getters and setters all have full sentence JavaDoc

luke czapla · luke czapla · commit 29ec56453f89 · 2017-07-31T16:53:03.000-04:00
diff --git a/biojava-structure/src/main/java/org/biojava/nbio/structure/basepairs/MismatchedBasePairParameters.java b/biojava-structure/src/main/java/org/biojava/nbio/structure/basepairs/MismatchedBasePairParameters.java
@@ -120,34 +120,66 @@ public List<Pair<Group>> findPairs(List<Chain> chains) {
         return result;
     }
 
+    /**
+     * This method returns the maximum stagger between bases used as criteria for the characterization of two bases as being paired.
+     * @return the maximum propeller ("propeller-twist", in degrees) allowed.
+     */
     public static double getMaxStagger() {
         return MaxStagger;
     }
 
+    /**
+     * This method sets the maximum stagger allowed for a base pair, prior to analyze() call
+     * @param maxStagger The maximum propeller (in Å) allowed to consider two bases paired
+     */
     public static void setMaxStagger(double maxStagger) {
         MaxStagger = maxStagger;
     }
 
+    /**
+     * This method returns the maximum shear between bases used as criteria for the characterization of two bases as being paired.
+     * @return the maximum shear (in Å) allowed.
+     */
     public static double getMaxShear() {
         return MaxShear;
     }
 
+    /**
+     * This method sets the maximum shear allowed for a base pair, prior to analyze() call
+     * @param maxShear The maximum shear (in Å) allowed to consider two bases paired
+     */
     public static void setMaxShear(double maxShear) {
         MaxShear = maxShear;
     }
 
+    /**
+     * This method returns the maximum stretch between bases used as criteria for the characterization of two bases as being paired.
+     * @return the maximum stretch (in Å) allowed.
+     */
     public static double getMaxStretch() {
         return MaxStretch;
     }
 
+    /**
+     * This method sets the maximum stretch allowed for a base pair, prior to analyze() call.
+     * @param maxStretch The maximum stretch (in Å) allowed to consider two bases paired
+     */
     public static void setMaxStretch(double maxStretch) {
         MaxStretch = maxStretch;
     }
 
+    /**
+     * This method returns the maximum propeller twist between bases used as criteria for the characterization of two bases as being paired.
+     * @return the maximum propeller ("propeller-twist", in degrees) allowed.
+     */
     public static double getMaxPropeller() {
         return MaxPropeller;
     }
 
+    /**
+     * This method sets the maximum propeller allowed for a base pair, prior to analyze() call
+     * @param maxPropeller The maximum propeller ("propeller-twist", in degrees) allowed to consider two bases paired
+     */
     public static void setMaxPropeller(double maxPropeller) {
         MaxPropeller = maxPropeller;
     }
diff --git a/biojava-structure/src/main/java/org/biojava/nbio/structure/basepairs/TertiaryBasePairParameters.java b/biojava-structure/src/main/java/org/biojava/nbio/structure/basepairs/TertiaryBasePairParameters.java
@@ -102,26 +102,33 @@ public List<Pair<Group>> findPairs(List<Chain> chains) {
         return result;
     }
 
+    /**
+     * This method returns the maximum stagger between bases used as criteria for the characterization of two bases as being paired.
+     * @return the maximum stagger (in Å) allowed.
+     */
     public static double getMaxStagger() {
         return MaxStagger;
     }
 
     /**
-     * Set the maximum stagger allowed for a base pair, prior to analyze() call
-     * @param maxStagger The maximum stagger allowed to consider two bases paired
+     * This method sets the maximum stagger allowed for a base pair, prior to analyze() call
+     * @param maxStagger The maximum stagger (in Å) allowed to consider two bases paired
      */
     public static void setMaxStagger(double maxStagger) {
         MaxStagger = maxStagger;
     }
 
-
+    /**
+     * This method returns the maximum propeller twist between bases used as criteria for the characterization of two bases as being paired.
+     * @return the maximum propeller ("propeller-twist", in degrees) allowed.
+     */
     public static double getMaxPropeller() {
         return MaxPropeller;
     }
 
     /**
-     * Set the maximum propeller allowed for a base pair, prior to analyze() call
-     * @param maxPropeller The maximum propeller (a.k.a. "propeller-twist") allowed to consider two bases paired
+     * This method sets the maximum propeller allowed for a base pair, prior to analyze() call
+     * @param maxPropeller The maximum propeller ("propeller-twist", in degrees) allowed to consider two bases paired
      */
     public static void setMaxPropeller(double maxPropeller) {
         MaxPropeller = maxPropeller;
