svn commit: r1200274 - /lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/SearcherLifetimeManager.java

[mi...@apache.org]

Author: mikemccand
Date: Thu Nov 10 11:30:21 2011
New Revision: 1200274

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

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

Modified: lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/SearcherLifetimeManager.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/SearcherLifetimeManager.java?rev=1200274&r1=1200273&r2=1200274&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/SearcherLifetimeManager.java (original)
+++ lucene/dev/trunk/lucene/src/java/org/apache/lucene/search/SearcherLifetimeManager.java Thu Nov 10 11:30:21 2011
@@ -46,8 +46,9 @@ import org.apache.lucene.util.IOUtils;
  * then record this searcher:
  *
  * <pre>
- *   // Record token into user's search results, eg as a
- *   // hidden HTML form field:
+ *   // Record the current searcher, and save the returend
+ *   // token into user's search results (eg as a  hidden
+ *   // HTML form field):
  *   long token = mgr.record(searcher);
  * </pre>
  *
@@ -56,9 +57,9 @@ import org.apache.lucene.util.IOUtils;
  * that you saved from the previous search and:
  *
  * <pre>
- *   // If possible, obtain same searcher version as last
+ *   // If possible, obtain the same searcher as the last
  *   // search:
- *   IndexSearcher searcher = mgr.acquire(version);
+ *   IndexSearcher searcher = mgr.acquire(token);
  *   if (searcher != null) {
  *     // Searcher is still here
  *     try {
@@ -79,7 +80,7 @@ import org.apache.lucene.util.IOUtils;
  * periodically prune old searchers:
  *
  * <pre>
- *   mgr.prune(new PruneByAge(600.0);
+ *   mgr.prune(new PruneByAge(600.0));
  * </pre>
  *
  * <p><b>NOTE</b>: keeping many searchers around means