jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1649423 - in /jmeter/trunk/src: core/org/apache/jmeter/testelement/property/ protocol/http/org/apache/jmeter/protocol/http/sampler/ reports/org/apache/jmeter/testelement/
Date Sun, 04 Jan 2015 21:13:50 GMT
Author: fschumacher
Date: Sun Jan  4 21:13:50 2015
New Revision: 1649423

URL: http://svn.apache.org/r1649423
Log:
Bug 57193: Add param and return tags to javadoc
Bugzilla Id: 57193


Modified:
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/AbstractProperty.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java
    jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java
    jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/AbstractProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/AbstractProperty.java?rev=1649423&r1=1649422&r2=1649423&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/AbstractProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/AbstractProperty.java Sun
Jan  4 21:13:50 2015
@@ -252,6 +252,8 @@ public abstract class AbstractProperty i
     /**
      * Get the property type for this property. Used to convert raw values into
      * JMeterProperties.
+     *
+     * @return property type of this property
      */
     protected Class<? extends JMeterProperty> getPropertyType() {
         return getClass();
@@ -318,6 +320,10 @@ public abstract class AbstractProperty i
     /**
      * Given a Map, it converts the Map into a collection of JMeterProperty
      * objects, appropriate for a MapProperty object.
+     *
+     * @param coll
+     *            Map to convert
+     * @return converted Map
      */
     protected Map<String, JMeterProperty> normalizeMap(Map<?,?> coll) {
         if (coll.isEmpty()) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java?rev=1649423&r1=1649422&r2=1649423&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/property/JMeterProperty.java Sun Jan
 4 21:13:50 2015
@@ -26,7 +26,7 @@ public interface JMeterProperty extends
     /**
      * Returns whether the property is a running version.
      *
-     * @return boolean
+     * @return flag whether this property is a running version
      */
     boolean isRunningVersion();
 
@@ -34,14 +34,14 @@ public interface JMeterProperty extends
      * The name of the property. Typically this should match the name that keys
      * the property's location in the test elements Map.
      *
-     * @return String
+     * @return the name of the property
      */
     String getName();
 
     /**
      * Set the property name.
      *
-     * @param name
+     * @param name the name of the property
      */
     void setName(String name);
 
@@ -54,7 +54,7 @@ public interface JMeterProperty extends
      * value. A non-running version property will return functions as their
      * uncompiled string representation.
      *
-     * @param runningVersion
+     * @param runningVersion flag whether this property is a running version
      */
     void setRunningVersion(boolean runningVersion);
 
@@ -72,7 +72,7 @@ public interface JMeterProperty extends
      * But for collection properties and test element properties, more complex
      * behavior is required.
      *
-     * @param prop
+     * @param prop the property object to merge into this property
      */
     void mergeIn(JMeterProperty prop);
 

Modified: jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java?rev=1649423&r1=1649422&r2=1649423&view=diff
==============================================================================
--- jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java
(original)
+++ jmeter/trunk/src/protocol/http/org/apache/jmeter/protocol/http/sampler/HTTPSamplerBase.java
Sun Jan  4 21:13:50 2015
@@ -1546,9 +1546,9 @@ public abstract class HTTPSamplerBase ex
      * an HTTPSamplerResult container parameter instead of a
      * boolean:areFollowingRedirect.
      *
-     * @param areFollowingRedirect
-     * @param frameDepth
-     * @param res
+     * @param areFollowingRedirect flag whether we are getting a redirect target
+     * @param frameDepth Depth of this target in the frame structure. Used only to prevent
infinite recursion.
+     * @param res sample result to process
      * @return the sample result
      */
     protected HTTPSampleResult resultProcessing(boolean areFollowingRedirect, int frameDepth,
HTTPSampleResult res) {
@@ -1588,6 +1588,7 @@ public abstract class HTTPSamplerBase ex
      * Determine if the HTTP status code is successful or not
      * i.e. in range 200 to 399 inclusive
      *
+     * @param code status code to check
      * @return whether in range 200-399 or not
      */
     protected boolean isSuccessCode(int code){

Modified: jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java?rev=1649423&r1=1649422&r2=1649423&view=diff
==============================================================================
--- jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java (original)
+++ jmeter/trunk/src/reports/org/apache/jmeter/testelement/LineChart.java Sun Jan  4 21:13:50
2015
@@ -112,9 +112,11 @@ public class LineChart extends AbstractC
     }
 
     /**
-     * Since we only have 4 shapes, the method will start with the
-     * first shape and keep cycling through the shapes in order.
+     * Since we only have 4 shapes, the method will start with the first shape
+     * and keep cycling through the shapes in order.
+     *
      * @param count
+     *            number of shapes to create
      * @return array of shapes
      */
     public Shape[] createShapes(int count) {
@@ -139,6 +141,7 @@ public class LineChart extends AbstractC
     /**
      *
      * @param count
+     *            number of strokes to create
      * @return array of strokes
      */
     public Stroke[] createStrokes(int count) {



Mime
View raw message