jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1649318 - in /jmeter/trunk/src: components/org/apache/jmeter/visualizers/backend/ components/org/apache/jmeter/visualizers/backend/graphite/ core/org/apache/jmeter/reporters/ core/org/apache/jmeter/testelement/ core/org/apache/jmeter/visua...
Date Sun, 04 Jan 2015 12:14:42 GMT
Author: fschumacher
Date: Sun Jan  4 12:14:41 2015
New Revision: 1649318

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

Modified:
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListener.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerClient.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerGui.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteBackendListenerClient.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteMetricsSender.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketConnectionInfos.java
    jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketOutputStream.java
    jmeter/trunk/src/core/org/apache/jmeter/reporters/SummariserRunningSample.java
    jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElementTraverser.java
    jmeter/trunk/src/core/org/apache/jmeter/visualizers/RunningSample.java
    jmeter/trunk/src/core/org/apache/jmeter/visualizers/SamplingStatCalculator.java

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListener.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListener.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListener.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListener.java
Sun Jan  4 12:14:41 2015
@@ -466,7 +466,7 @@ public class BackendListener extends Abs
     /**
      * Sets the queue size
      *
-     * @param queueSize
+     * @param queueSize the size of the queue
      *            
      */
     public void setQueueSize(String queueSize) {

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerClient.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerClient.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerClient.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerClient.java
Sun Jan  4 12:14:41 2015
@@ -70,6 +70,7 @@ public interface BackendListenerClient {
      * @param context
      *            the context to run with. This provides access to
      *            initialization parameters.
+     * @throws Exception when setup fails
      */
     void setupTest(BackendListenerContext context) throws Exception;
 
@@ -100,6 +101,7 @@ public interface BackendListenerClient {
      * @param context
      *            the context to run with. This provides access to
      *            initialization parameters.
+     * @throws Exception when tear down fails
      */
     void teardownTest(BackendListenerContext context) throws Exception;
 

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerGui.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerGui.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerGui.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/BackendListenerGui.java
Sun Jan  4 12:14:41 2015
@@ -154,7 +154,7 @@ public class BackendListenerGui extends
      * Handle action events for this component. This method currently handles
      * events for the classname combo box.
      *
-     * @param evt
+     * @param event
      *            the ActionEvent to be handled
      */
     @Override

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteBackendListenerClient.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteBackendListenerClient.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteBackendListenerClient.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteBackendListenerClient.java
Sun Jan  4 12:14:41 2015
@@ -40,7 +40,7 @@ import org.apache.log.Logger;
 
 /**
  * Graphite based Listener using Pickle Protocol
- * @see http://graphite.readthedocs.org/en/latest/overview.html
+ * @see <a href="http://graphite.readthedocs.org/en/latest/overview.html">Graphite
Overview</a>
  * @since 2.13
  */
 public class GraphiteBackendListenerClient extends AbstractBackendListenerClient implements
Runnable {

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteMetricsSender.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteMetricsSender.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteMetricsSender.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/GraphiteMetricsSender.java
Sun Jan  4 12:14:41 2015
@@ -43,9 +43,9 @@ interface GraphiteMetricsSender {
      *      (timestamp, (prefix.contextName.metricName, metricValue))
      * And add it to the list of metrics. 
      * @param timestamp in Seconds from 1970
-     * @param contextName
-     * @param metricName
-     * @param metricValue
+     * @param contextName name of the context of this metric
+     * @param metricName name of this metric
+     * @param metricValue value of this metric
      */
     public abstract void addMetric(long timestamp, String contextName,
             String metricName, String metricValue);

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketConnectionInfos.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketConnectionInfos.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketConnectionInfos.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketConnectionInfos.java
Sun Jan  4 12:14:41 2015
@@ -27,8 +27,8 @@ public class SocketConnectionInfos {
     private int port;
     
     /**
-     * @param host
-     * @param port
+     * @param host the name of the host to connect to
+     * @param port the port to connect to
      */
     public SocketConnectionInfos(String host, int port) {
         super();

Modified: jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketOutputStream.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketOutputStream.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketOutputStream.java
(original)
+++ jmeter/trunk/src/components/org/apache/jmeter/visualizers/backend/graphite/SocketOutputStream.java
Sun Jan  4 12:14:41 2015
@@ -42,6 +42,8 @@ public class SocketOutputStream extends
 
     /**
      * Return the underlying Socket
+     *
+     * @return the underlying {@link Socket}
      */
     public Socket getSocket() {
         return socket;

Modified: jmeter/trunk/src/core/org/apache/jmeter/reporters/SummariserRunningSample.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/reporters/SummariserRunningSample.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/reporters/SummariserRunningSample.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/reporters/SummariserRunningSample.java Sun Jan
 4 12:14:41 2015
@@ -31,7 +31,7 @@ import org.apache.jmeter.samplers.Sample
  * <p>
  * Please note that this class is not thread-safe.
  * The calling class is responsible for ensuring thread safety if required.
- * The caller needs to synchronize access in order to enure that variables are consistent.
+ * The caller needs to synchronize access in order to ensure that variables are consistent.
  * </p>
  * @since 2.13
  */
@@ -56,7 +56,7 @@ class SummariserRunningSample {
     private final String label;
 
     /**
-     * @param label
+     * @param label the label of this component
      */
     public SummariserRunningSample(String label) {
         this.label = label;
@@ -157,6 +157,8 @@ class SummariserRunningSample {
 
     /**
      * Returns the throughput associated to this sampler in requests per second.
+     *
+     * @return throughput associated to this sampler
      */
     public double getRate() {
         if (counter == 0) {

Modified: jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElementTraverser.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElementTraverser.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElementTraverser.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/testelement/TestElementTraverser.java Sun Jan
 4 12:14:41 2015
@@ -31,14 +31,14 @@ public interface TestElementTraverser {
     /**
      * Notification that a new test element is about to be traversed.
      *
-     * @param el
+     * @param el element to be traversed
      */
     void startTestElement(TestElement el);
 
     /**
      * Notification that the test element is now done.
      *
-     * @param el
+     * @param el element that was traversed
      */
     void endTestElement(TestElement el);
 
@@ -46,15 +46,15 @@ public interface TestElementTraverser {
      * Notification that a property is starting. This could be a test element
      * property or a Map property - depends on the context.
      *
-     * @param key
+     * @param key property to be traversed
      */
     void startProperty(JMeterProperty key);
 
     /**
      * Notification that a property is ending. Again, this could be a test
-     * element or a Map property, dependig on the context.
+     * element or a Map property, depending on the context.
      *
-     * @param key
+     * @param key property that was traversed
      */
     void endProperty(JMeterProperty key);
 

Modified: jmeter/trunk/src/core/org/apache/jmeter/visualizers/RunningSample.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/visualizers/RunningSample.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/visualizers/RunningSample.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/visualizers/RunningSample.java Sun Jan  4 12:14:41
2015
@@ -32,7 +32,7 @@ import org.apache.jmeter.samplers.Sample
  * Please note that this class is not thread-safe.
  * The calling class is responsible for ensuring thread safety if required.
  * Versions prior to 2.3.2 appeared to be thread-safe but weren't as label and index were
not final.
- * Also the caller needs to synchronize access in order to enure that variables are consistent.
+ * Also the caller needs to synchronize access in order to ensure that variables are consistent.
  * </p>
  *
  */
@@ -60,6 +60,9 @@ public class RunningSample {
 
     /**
      * Use this constructor to create the initial instance
+     *
+     * @param label the label for this component
+     * @param index the index of this component
      */
     public RunningSample(String label, int index) {
         this.label = label;
@@ -120,6 +123,8 @@ public class RunningSample {
      * May be slightly skewed because it takes the timestamps of the first and
      * last samples as the total time passed, and the test may actually have
      * started before that start time and ended after that end time.
+     *
+     * @return throughput associated with this sampler per second
      */
     public double getRate() {
         if (counter == 0) {
@@ -140,6 +145,8 @@ public class RunningSample {
      * May be slightly skewed because it takes the timestamps of the first and
      * last samples as the total time passed, and the test may actually have
      * started before that start time and ended after that end time.
+     *
+     * @return throughput associated with this sampler per minute
      */
     public double getRatePerMin() {
         if (counter == 0) {
@@ -187,10 +194,16 @@ public class RunningSample {
         return rateFormatter.format(rate) + "/" + unit;
     }
 
+    /**
+     * @return the label for this component
+     */
     public String getLabel() {
         return label;
     }
 
+    /**
+     * @return the index of this component
+     */
     public int getIndex() {
         return index;
     }
@@ -198,6 +211,7 @@ public class RunningSample {
     /**
      * Records a sample.
      *
+     * @param res sample to record
      */
     public void addSample(SampleResult res) {
         long aTimeInMillis = res.getTime();
@@ -232,6 +246,8 @@ public class RunningSample {
     /**
      * Adds another RunningSample to this one.
      * Does not check if it has the same label and index.
+     *
+     * @param rs sample to add
      */
     public void addSample(RunningSample rs) {
         this.counter += rs.counter;

Modified: jmeter/trunk/src/core/org/apache/jmeter/visualizers/SamplingStatCalculator.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/visualizers/SamplingStatCalculator.java?rev=1649318&r1=1649317&r2=1649318&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/visualizers/SamplingStatCalculator.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/visualizers/SamplingStatCalculator.java Sun Jan
 4 12:14:41 2015
@@ -24,7 +24,7 @@ import org.apache.jmeter.samplers.Sample
 import org.apache.jorphan.math.StatCalculatorLong;
 
 /**
- * Aggegate sample data container. Just instantiate a new instance of this
+ * Aggregate sample data container. Just instantiate a new instance of this
  * class, and then call {@link #addSample(SampleResult)} a few times, and pull
  * the stats out with whatever methods you prefer.
  *
@@ -85,6 +85,8 @@ public class SamplingStatCalculator {
      * May be slightly skewed because it takes the timestamps of the first and
      * last samples as the total time passed, and the test may actually have
      * started before that start time and ended after that end time.
+     *
+     * @return throughput associated with this sampler per second
      */
     public double getRate() {
         if (calculator.getCount() == 0) {
@@ -134,6 +136,9 @@ public class SamplingStatCalculator {
         return calculator.getTotalBytes() / (double) count;
     }
 
+    /**
+     * @return the label of this component
+     */
     public String getLabel() {
         return label;
     }
@@ -141,6 +146,10 @@ public class SamplingStatCalculator {
     /**
      * Records a sample.
      *
+     * @param res
+     *            the sample to record
+     * @return newly created sample with current statistics
+     *
      */
     public Sample addSample(SampleResult res) {
         long rtime, cmean, cstdv, cmedian, cpercent, eCount, endTime;



Mime
View raw message