You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by ds...@apache.org on 2012/09/09 18:14:13 UTC

svn commit: r1382528 - in /lucene/dev/branches/branch_4x: ./ lucene/ lucene/core/ lucene/core/src/java/org/apache/lucene/index/ lucene/facet/ lucene/facet/src/java/org/apache/lucene/facet/taxonomy/writercache/lru/ lucene/spatial/ lucene/spatial/src/java/

Author: dsmiley
Date: Sun Sep  9 16:14:12 2012
New Revision: 1382528

URL: http://svn.apache.org/viewvc?rev=1382528&view=rev
Log:
Improve spatial javadocs, and fixed some javadoc warnings in 2 other places.

Modified:
    lucene/dev/branches/branch_4x/   (props changed)
    lucene/dev/branches/branch_4x/lucene/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/   (props changed)
    lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
    lucene/dev/branches/branch_4x/lucene/facet/   (props changed)
    lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/writercache/lru/NameIntCacheLRU.java
    lucene/dev/branches/branch_4x/lucene/spatial/   (props changed)
    lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html

Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java?rev=1382528&r1=1382527&r2=1382528&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/index/IndexWriter.java Sun Sep  9 16:14:12 2012
@@ -2214,7 +2214,7 @@ public class IndexWriter implements Clos
    * {@link #prepareFlushedSegment(FlushedSegment)} to obtain the
    * {@link SegmentInfo} for the flushed segment.
    * 
-   * @see #prepareFlushedSegment(FlushedSegment)
+   * @see #prepareFlushedSegment(DocumentsWriterPerThread.FlushedSegment)
    */
   synchronized void publishFlushedSegment(SegmentInfoPerCommit newSegment,
       FrozenBufferedDeletes packet, FrozenBufferedDeletes globalPacket) throws IOException {

Modified: lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/writercache/lru/NameIntCacheLRU.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/writercache/lru/NameIntCacheLRU.java?rev=1382528&r1=1382527&r2=1382528&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/writercache/lru/NameIntCacheLRU.java (original)
+++ lucene/dev/branches/branch_4x/lucene/facet/src/java/org/apache/lucene/facet/taxonomy/writercache/lru/NameIntCacheLRU.java Sun Sep  9 16:14:12 2012
@@ -70,8 +70,6 @@ class NameIntCacheLRU {
 
   /**
    * Subclasses can override this to provide caching by e.g. hash of the string.
-   * @param name
-   * @return
    */
   Object key(CategoryPath name) {
     // Note that a copy constructor (cloning) here is necessary, because a

Modified: lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html?rev=1382528&r1=1382527&r2=1382528&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html (original)
+++ lucene/dev/branches/branch_4x/lucene/spatial/src/java/overview.html Sun Sep  9 16:14:12 2012
@@ -23,16 +23,18 @@
   <h1>The Spatial Module for Apache Lucene</h1>
 
   <p>
-    The spatial module is new is Lucene 4, replacing the old contrib module
+    The spatial module is new to Lucene 4, replacing the old "contrib" module
     that came before it. The principle interface to the module is
     a {@link org.apache.lucene.spatial.SpatialStrategy}
     which encapsulates an approach to indexing and searching
     based on shapes.  Different Strategies have different features and
-    performance profiles, which are documented at each Strategy class level.
+    performance profiles, which are documented at each Strategy implementation
+    class level.
   </p>
   <p>
-    For some sample code showing how to use the API, see SpatialExample.java in
-    the tests.
+    For some sample code showing how to use the API, see
+    <a href="https://svn.apache.org/repos/asf/lucene/dev/trunk/lucene/spatial/src/test/org/apache/lucene/spatial/SpatialExample.java">
+      SpatialExample.java</a> in the tests.
   </p>
   <p>
     The spatial module uses
@@ -57,7 +59,9 @@
     Lucene Spatial Playground (LSP) as an external project.  In ~March 2012, LSP
     split into this new module as part of Lucene and Spatial4j externally. A
     large chunk of the LSP implementation originated as SOLR-2155 which uses
-    trie/prefix-tree algorithms with a geohash encoding.
+    trie/prefix-tree algorithms with a geohash encoding.  That approach is
+    implemented in {@link org.apache.lucene.spatial.prefix.RecursivePrefixTreeStrategy}
+    today.
   </p>
 
   </body>