You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by si...@apache.org on 2011/11/12 06:19:42 UTC

svn commit: r1201191 - /lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/TimeLimitingCollector.java

Author: simonw
Date: Sat Nov 12 05:19:41 2011
New Revision: 1201191

URL: http://svn.apache.org/viewvc?rev=1201191&view=rev
Log:
fix javadocs

Modified:
    lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/TimeLimitingCollector.java

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/TimeLimitingCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/TimeLimitingCollector.java?rev=1201191&r1=1201190&r2=1201191&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/TimeLimitingCollector.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/TimeLimitingCollector.java Sat Nov 12 05:19:41 2011
@@ -69,7 +69,9 @@ public class TimeLimitingCollector exten
   /**
    * Create a TimeLimitedCollector wrapper over another {@link Collector} with a specified timeout.
    * @param collector the wrapped {@link Collector}
-   * @param timeAllowed max time allowed for collecting hits after which {@link TimeExceededException} is thrown
+   * @param clock the timer clock
+   * @param ticksAllowed max time allowed for collecting
+   * hits after which {@link TimeExceededException} is thrown
    */
   public TimeLimitingCollector(final Collector collector, Counter clock, final long ticksAllowed ) {
     this.collector = collector;
@@ -79,10 +81,9 @@ public class TimeLimitingCollector exten
   
   /**
    * Sets the baseline for this collector. By default the collectors baseline is 
-   * initialized once the first reader is passed to
-   * {@link #setNextReader(AtomicReaderContext)}. To include operations executed
-   * in prior to the actual document collection set the baseline through this method
-   * in your prelude.
+   * initialized once the first reader is passed to the collector. 
+   * To include operations executed in prior to the actual document collection
+   * set the baseline through this method in your prelude.
    * <p>
    * Example usage:
    * <pre>