svn commit: r1245715 - /lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NRTManager.java

[mi...@apache.org]

Author: mikemccand
Date: Fri Feb 17 19:25:19 2012
New Revision: 1245715

URL: http://svn.apache.org/viewvc?rev=1245715&view=rev
Log:
LUCENE-3776: javadocs

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

Modified: lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NRTManager.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NRTManager.java?rev=1245715&r1=1245714&r2=1245715&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NRTManager.java (original)
+++ lucene/dev/trunk/lucene/core/src/java/org/apache/lucene/search/NRTManager.java Fri Feb 17 19:25:19 2012
@@ -51,13 +51,11 @@ import org.apache.lucene.util.ThreadInte
  * not.  In this case you should use a single {@link
  * NRTManager.TrackingIndexWriter} instance for both.
  *
- * <p>Then, use {@link #getSearcherManager} to obtain the
- * {@link SearcherManager} that you then use to
- * acquire/release searchers.  Don't call maybeReopen on
- * that SearcherManager!  Only call NRTManager's {@link
- * #maybeReopen}.
+ * <p>Then, use {@link #acquire} to obtain the
+ * {@link IndexSearcher}, and {@link #release} (ideally,
+ * from within a <code>finally</code> clause) to release it.
  *
- * <p>NOTE: to use this class, you must call {@link #maybeReopen()}
+ * <p>NOTE: to use this class, you must call {@link #maybeRefresh()}
  * periodically.  The {@link NRTManagerReopenThread} is a
  * simple class to do this on a periodic basis, and reopens
  * more quickly if a request is waiting.  If you implement
@@ -265,7 +263,7 @@ public class NRTManager extends Referenc
    * If the current searcher is older than the
    * target generation, this method will block
    * until the searcher is reopened, by another via
-   * {@link #maybeReopen} or until the {@link NRTManager} is closed.
+   * {@link #maybeRefresh} or until the {@link NRTManager} is closed.
    * 
    * @param targetGen the generation to wait for
    */
@@ -278,7 +276,7 @@ public class NRTManager extends Referenc
    * the searcher.  If the current searcher is older than
    * the target generation, this method will block until the
    * searcher has been reopened by another thread via
-   * {@link #maybeReopen}, the given waiting time has elapsed, or until
+   * {@link #maybeRefresh}, the given waiting time has elapsed, or until
    * the NRTManager is closed.
    * <p>
    * NOTE: if the waiting time elapses before the requested target generation is