changeset 827:7ee95e9cf56c

Javadocs for @Param should mention sequential order.
author shade
date Wed, 25 Jun 2014 17:24:04 +0400
parents 0b475b9628dc
children 55aa4c748a0e
files jmh-core/src/main/java/org/openjdk/jmh/annotations/Param.java jmh-core/src/main/java/org/openjdk/jmh/runner/options/ChainedOptionsBuilder.java
diffstat 2 files changed, 7 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/jmh-core/src/main/java/org/openjdk/jmh/annotations/Param.java	Mon Jun 23 22:23:48 2014 +0400
+++ b/jmh-core/src/main/java/org/openjdk/jmh/annotations/Param.java	Wed Jun 25 17:24:04 2014 +0400
@@ -54,7 +54,9 @@
     static final String BLANK_ARGS = "blank_blank_blank_2014";
 
     /**
-     * Default values for the parameter.
+     * Default values sequence for the parameter. The parameter values
+     * would be taken in the order given by user.
+     *
      * @return values sequence to follow.
      */
     String[] value() default { BLANK_ARGS };
--- a/jmh-core/src/main/java/org/openjdk/jmh/runner/options/ChainedOptionsBuilder.java	Mon Jun 23 22:23:48 2014 +0400
+++ b/jmh-core/src/main/java/org/openjdk/jmh/runner/options/ChainedOptionsBuilder.java	Wed Jun 25 17:24:04 2014 +0400
@@ -288,9 +288,11 @@
     ChainedOptionsBuilder detectJvmArgs();
 
     /**
-     * Set benchmark parameter.
+     * Set benchmark parameter values.
+     * The parameter values would be taken in the order given by user.
+     *
      * @param name parameter
-     * @param values list of values to set
+     * @param values sequence of values to set
      * @return builder
      * @see org.openjdk.jmh.annotations.Param
      */