svn commit: r998535 - in /commons/sandbox/performance/trunk/src/java/org/apache/commons/performance: ClientThread.java LoadGenerator.java Statistics.java

[ps...@apache.org]

Author: psteitz
Date: Sat Sep 18 20:39:42 2010
New Revision: 998535

URL: http://svn.apache.org/viewvc?rev=998535&view=rev
Log:
javadoc fixes.

Modified:
    commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/ClientThread.java
    commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/LoadGenerator.java
    commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/Statistics.java

Modified: commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/ClientThread.java
URL: http://svn.apache.org/viewvc/commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/ClientThread.java?rev=998535&r1=998534&r2=998535&view=diff
==============================================================================
--- commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/ClientThread.java (original)
+++ commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/ClientThread.java Sat Sep 18 20:39:42 2010
@@ -101,16 +101,17 @@ public abstract class ClientThread imple
      * Create a client thread.
      * 
      * @param iterations number of iterations
-     * @param minDelay minumum mean time between client requests
+     * @param minDelay minimum mean time between client requests
      * @param maxDelay maximum mean time between client requests
+     * @param sigma standard deviation of time between client requests
      * @param delayType distribution of time between client requests
      * @param rampPeriod ramp period of cycle for cyclic load
-     * @param peakOeriod peak period of cycle for cyclic load
+     * @param peakPeriod peak period of cycle for cyclic load
      * @param troughPeriod trough period of cycle for cyclic load
      * @param cycleType type of cycle for mean delay
      * @param rampType type of ramp (linear or random jumps)
      * @param logger common logger shared by all clients
-     * @param statsList List of SummaryStatistics to add results to
+     * @param stats Statistics instance to add results to
      */
     public ClientThread(long iterations, long minDelay, long maxDelay,
             double sigma, String delayType, long rampPeriod, long peakPeriod,

Modified: commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/LoadGenerator.java
URL: http://svn.apache.org/viewvc/commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/LoadGenerator.java?rev=998535&r1=998534&r2=998535&view=diff
==============================================================================
--- commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/LoadGenerator.java (original)
+++ commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/LoadGenerator.java Sat Sep 18 20:39:42 2010
@@ -32,7 +32,7 @@ import org.apache.commons.digester.Diges
  * 
  * <p>Subclasses <code>must</code> implement <code>makeClientThread</code> to
  * create client thread instances to be kicked off by <code>execute.</code>
- * Sublasses will also in general override <code>configure</code> to load
+ * Subclasses will also in general override <code>configure</code> to load
  * additional configuration parameters and pass them on to the client in 
  * <code>makeClientThread.</code>  Implementations of <code>configure</code>
  * should start with a <code>super()</code> call so that the base configuration
@@ -140,7 +140,7 @@ public abstract class LoadGenerator {
     /**
      * This method is invoked by {@link #execute()} after all spawned threads
      * have terminated. Override to clean up any resources allocated in 
-     * {@link #init().
+     * {@link #init()}.
      * 
      * @throws Exception
      */
@@ -151,10 +151,10 @@ public abstract class LoadGenerator {
      * Configures basic run parameters. Invoked by Digester via a rule defined
      * in {@link #configure()}.
      * 
-     * @param iterations number of iterationss
+     * @param iterations number of iterations
      * @param clients number of client threads
      * @param minDelay minimum delay between client thread requests (ms)
-     * @param maxDelay maximimum delay between client thread requests (ms)
+     * @param maxDelay maximum delay between client thread requests (ms)
      * @param sigma standard deviation of delay
      * @param delayType type of delay (constant, gaussian, poisson)
      * @param rampType type of ramp (none, linear, random)

Modified: commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/Statistics.java
URL: http://svn.apache.org/viewvc/commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/Statistics.java?rev=998535&r1=998534&r2=998535&view=diff
==============================================================================
--- commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/Statistics.java (original)
+++ commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/Statistics.java Sat Sep 18 20:39:42 2010
@@ -96,7 +96,7 @@ public class Statistics implements Seria
      * the given <code>process</code> - i.e, the list of statistics of
      * of different types maintained for the given process. 
      * 
-     * @param type the type value to get statistics for
+     * @param process the process to get statistics for
      * @return the List of SummaryStatistics for the given process
      */
     public synchronized List<SummaryStatistics> getStatisticsByProcess(