svn commit: r1782578 - /jmeter/trunk/src/jorphan/org/apache/jorphan/gui/ObjectTableSorter.java

[fs...@apache.org]

Author: fschumacher
Date: Sat Feb 11 10:25:12 2017
New Revision: 1782578

URL: http://svn.apache.org/viewvc?rev=1782578&view=rev
Log:
Javadoc: add return and param tags.

Modified:
    jmeter/trunk/src/jorphan/org/apache/jorphan/gui/ObjectTableSorter.java

Modified: jmeter/trunk/src/jorphan/org/apache/jorphan/gui/ObjectTableSorter.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/jorphan/org/apache/jorphan/gui/ObjectTableSorter.java?rev=1782578&r1=1782577&r2=1782578&view=diff
==============================================================================
--- jmeter/trunk/src/jorphan/org/apache/jorphan/gui/ObjectTableSorter.java (original)
+++ jmeter/trunk/src/jorphan/org/apache/jorphan/gui/ObjectTableSorter.java Sat Feb 11 10:25:12 2017
@@ -95,21 +95,22 @@ public class ObjectTableSorter extends R
     }
 
     /**
-     * Comparator used prior to sorted columns.
+     * @return Comparator used prior to sorted columns.
      */
     public Comparator<Row> getPrimaryComparator() {
         return primaryComparator;
     }
 
     /**
-     * Comparator used on sorted columns.
+     * @param column to be compared
+     * @return Comparator used on column.
      */
     public Comparator<?> getValueComparator(int column) {
         return valueComparators[column];
     }
 
     /**
-     * Comparator if all sorted columns matches. Defaults to model index comparison.
+     * @return Comparator if all sorted columns matches. Defaults to model index comparison.
      */
     public Comparator<Row> getFallbackComparator() {
         return fallbackComparator;
@@ -117,6 +118,7 @@ public class ObjectTableSorter extends R
 
     /**
      * Comparator used prior to sorted columns.
+     * @param primaryComparator {@link Comparator} to be used first
      * @return <code>this</code>
      */
     public ObjectTableSorter setPrimaryComparator(Comparator<Row> primaryComparator) {
@@ -134,7 +136,7 @@ public class ObjectTableSorter extends R
     }
 
     /**
-     * Assign comparator to given column, if <code>null</code> a {@link #getDefaultComparator(int) default one} is used instead.
+     * Assign comparator to given column, if <code>null</code> a getDefaultComparator(int) default one is used instead.
      * @param column Model column index.
      * @param comparator Column value comparator.
      * @return <code>this</code>
@@ -168,7 +170,14 @@ public class ObjectTableSorter extends R
     }
 
     /**
-     * Sets a fallback comparator (defaults to model index comparison) if none {@link #getPrimaryComparator() primary}, neither {@link #getValueComparator(int) column value comparators} can make differences between two rows.
+     * Sets a fallback comparator (defaults to model index comparison) if none
+     * {@link #getPrimaryComparator() primary}, neither
+     * {@link #getValueComparator(int) column value comparators} can make
+     * differences between two rows.
+     *
+     * @param comparator
+     *            to be used, when all other {@link Comparator}s can't see a
+     *            difference
      * @return <code>this</code>
      */
     public ObjectTableSorter setFallbackComparator(Comparator<Row> comparator) {