SeaseLtd#109: Add parameters to ERR javadoc.

mattflax · Mar 16, 2020 · 7a4636c · 7a4636c
1 parent 9ec19ad
commit 7a4636c
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/rre-core/src/main/java/io/sease/rre/core/domain/metrics/impl/ExpectedReciprocalRank.java b/rre-core/src/main/java/io/sease/rre/core/domain/metrics/impl/ExpectedReciprocalRank.java
@@ -45,6 +45,14 @@ public class ExpectedReciprocalRank extends Metric {
 
     /**
      * Builds a new ExpectedReciprocalRank metric with the default gain unit function and one diversity topic.
+     *
+     * @param k            the top k reference elements used for building the measure.
+     * @param maxgrade     the maximum grade available when judging documents. If
+     *                     {@code null}, will default to {@link Metric#DEFAULT_MAX_GRADE}.
+     * @param defaultgrade the default grade to use when judging documents. If
+     *                     {@code null}, will default to either {@code maxgrade / 2}
+     *                     or {@link Metric#DEFAULT_MISSING_GRADE}, depending
+     *                     whether or not {@code maxgrade} has been specified.
      */
     public ExpectedReciprocalRank(@JsonProperty("maxgrade") final Float maxgrade,
                                   @JsonProperty("defaultgrade") final Float defaultgrade,