contrib.benhmark.byTask javadocs corrections

git-svn-id: https://svn.apache.org/repos/asf/lucene/java/trunk@517566 13f79535-47bb-0310-9956-ffa450edef68

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/package.html

@@ -128,8 +128,8 @@ documents should be added to it one by one but not faster than 20 docs a minute,
 and, in parallel with this,
 some N queries should be searched against that index,
 again, no more than 2 queries a second.
-You can have the searches all share an index searcher,
-or have them each open its own searcher and close it afterwords.
+You can have the searches all share an index reader,
+or have them each open its own reader and close it afterwords.
 </p>
 
 <p>

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/ReadTask.java

@@ -32,7 +32,11 @@ import org.apache.lucene.store.Directory;
  * Read index (abstract) task.
  * Sub classes implement withSearch(), withWarm(), withTraverse() and withRetrieve()
  * methods to configure the actual action.
- * Other side effects: none.
+ * 
+ * <p>Note: All ReadTasks reuse the reader if it is already open. 
+ * Otherwise a reader is opened at start and closed at the end.
+ *  
+ * <p>Other side effects: none.
  */
 public abstract class ReadTask extends PerfTask {
 

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/SearchTask.java

@@ -22,6 +22,9 @@ import org.apache.lucene.benchmark.byTask.feeds.QueryMaker;
 
 /**
  * Search task.
+ * 
+ * <p>Note: This task reuses the reader if it is already open. 
+ * Otherwise a reader is opened at start and closed at the end.
  */
 public class SearchTask extends ReadTask {
 

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/SearchTravRetTask.java

@@ -22,6 +22,9 @@ import org.apache.lucene.benchmark.byTask.feeds.QueryMaker;
 
 /**
  * Search and Travrese and Retrieve docs task.
+ * 
+ * <p>Note: This task reuses the reader if it is already open. 
+ * Otherwise a reader is opened at start and closed at the end.
  */
 public class SearchTravRetTask extends ReadTask {
 

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/SearchTravTask.java

@@ -22,6 +22,9 @@ import org.apache.lucene.benchmark.byTask.feeds.QueryMaker;
 
 /**
  * Search and Travrese task.
+ * 
+ * <p>Note: This task reuses the reader if it is already open. 
+ * Otherwise a reader is opened at start and closed at the end.
  */
 public class SearchTravTask extends ReadTask {
 

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/TaskSequence.java

@@ -205,8 +205,7 @@ public class TaskSequence extends PerfTask {
   }
 
   /**
-   * Execute child tasks in a way that they do not reprt their time separately.
-   * Current implementation if child tasks has child tasks of their own, those are not affected by this call. 
+   * Execute child tasks in a way that they do not report their time separately.
    */
   public void setNoChildReport() {
     letChildReport  = false;

contrib/benchmark/src/java/org/apache/lucene/benchmark/byTask/tasks/WarmTask.java

@@ -22,6 +22,9 @@ import org.apache.lucene.benchmark.byTask.feeds.QueryMaker;
 
 /**
  * Warm reader task.
+ * 
+ * <p>Note: This task reuses the reader if it is already open. 
+ * Otherwise a reader is opened at start and closed at the end.
  */
 public class WarmTask extends ReadTask {