Author: psteitz
Date: Sat Nov 17 09:32:12 2007
New Revision: 595977

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

Modified:
    
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPClientThread.java
    
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPSoak.java
    
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/pool/PoolClientThread.java

Modified: 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPClientThread.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPClientThread.java?rev=595977&r1=595976&r2=595977&view=diff
==============================================================================
--- 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPClientThread.java
 (original)
+++ 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPClientThread.java
 Sat Nov 17 09:32:12 2007
@@ -28,9 +28,10 @@
 import org.apache.commons.performance.ClientThread;
 
 /**
- * Client thread that executes requests in a loop using a configured 
DataSource,
- * with number of requests, time between requests and query strings governed by
- * constructor parameters. See ClientThread javadoc for a description
+ * Client thread that executes requests in a loop using a configured
+ * DataSource, with the number of requests, time between requests and 
+ * query strings governed by constructor parameters. See 
+ * [EMAIL PROTECTED] ClientThread ClientThread javadoc} for a description
  * of how times between requests are computed.
  *
  */
@@ -50,11 +51,16 @@
      * Create a dbcp client thread.
      * 
      * @param iterations number of iterations
-     * @param delay mean time between client requests
+     * @param minDelay minimum delay time between client requests
+     * @param maxDelay maximum delay time between client requests
+     * @param sigma standard deviation of delay times between client requests
      * @param delayType distribution of time between client requests
      * @param queryType type of query 
-     * @param period period of cycle for cyclic load
+     * @param rampPeriod rampup, rampdown period for cyclic load
+     * @param peakPeriod period of sustained peak for cyclic load
+     * @param troughPeriod period of sustained minimum 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 dataSource DataSource for connections
      * @param statsList List of SummaryStatistics to add results to

Modified: 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPSoak.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPSoak.java?rev=595977&r1=595976&r2=595977&view=diff
==============================================================================
--- 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPSoak.java
 (original)
+++ 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/dbcp/DBCPSoak.java
 Sat Nov 17 09:32:12 2007
@@ -183,7 +183,7 @@
     
     // ------------------------------------------------------------------------
     // Configuration methods specific to this LoadGenerator invoked by Digester
-    // when superclass execute calls digerster.parse.
+    // when superclass execute calls digester.parse.
     // ------------------------------------------------------------------------
     public void configureDataBase(String driver, String url,
             String username, String password, String queryType) {
@@ -248,7 +248,18 @@
                 Integer.parseInt(abandonedTimeout));
     }
      
-    private void makeTable() throws Exception {
+    /**
+     * Creates and populates the test table (test_table) used in the 
+     * load tests. The created table will have 10,000 rows and 3 columns,
+     * populated with random data: <ul>
+     * <li> indexed (indexed integer column) </li>
+     * <li> not_indexed (non-indexed integer column) </li>
+     * <li> text (non-indexed varchar column) </li>
+     * </ul>
+     *
+     * @throws Exception
+     */
+    protected void makeTable() throws Exception {
         Class.forName(driverClass); 
         Connection db = DriverManager.getConnection(connectUrl,connectUser,
                 connectPassword);

Modified: 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/pool/PoolClientThread.java
URL: 
http://svn.apache.org/viewvc/commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/pool/PoolClientThread.java?rev=595977&r1=595976&r2=595977&view=diff
==============================================================================
--- 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/pool/PoolClientThread.java
 (original)
+++ 
commons/sandbox/performance/trunk/src/java/org/apache/commons/performance/pool/PoolClientThread.java
 Sat Nov 17 09:32:12 2007
@@ -26,7 +26,7 @@
 
 /**
  * Client thread that borrows and returns objects from a pool in a loop.
-   See ClientThread javadoc for a description
+ * See [EMAIL PROTECTED] ClientThread ClientThread javadoc} for a description
  * of how times between requests are computed.
  *
  */
@@ -38,13 +38,14 @@
      * Create a pool client thread.
      * 
      * @param iterations number of iterations
-     * @param minDelay minumum mean time between client requests
-     * @param maxDelay minumum mean time between client requests
+     * @param minDelay minimum mean time between client requests
+     * @param maxDelay maximum mean 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
      */


Reply via email to