You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by rm...@apache.org on 2012/09/20 16:31:49 UTC

svn commit: r1388044 - in /lucene/dev/trunk/lucene: ./ join/src/java/org/apache/lucene/search/join/

Author: rmuir
Date: Thu Sep 20 14:31:48 2012
New Revision: 1388044

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

Modified:
    lucene/dev/trunk/lucene/build.xml
    lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToChildBlockJoinQuery.java
    lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinCollector.java
    lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinQuery.java

Modified: lucene/dev/trunk/lucene/build.xml
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/build.xml?rev=1388044&r1=1388043&r2=1388044&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/build.xml (original)
+++ lucene/dev/trunk/lucene/build.xml Thu Sep 20 14:31:48 2012
@@ -250,7 +250,7 @@
       <check-missing-javadocs dir="build/docs/facet" level="class"/>
       <check-missing-javadocs dir="build/docs/grouping" level="class"/>
       <check-missing-javadocs dir="build/docs/highlighter" level="class"/>
-      <check-missing-javadocs dir="build/docs/join" level="class"/>
+      <check-missing-javadocs dir="build/docs/join" level="method"/>
       <check-missing-javadocs dir="build/docs/memory" level="class"/>
       <check-missing-javadocs dir="build/docs/misc" level="class"/>
       <!-- queries: problems -->

Modified: lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToChildBlockJoinQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToChildBlockJoinQuery.java?rev=1388044&r1=1388043&r2=1388044&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToChildBlockJoinQuery.java (original)
+++ lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToChildBlockJoinQuery.java Thu Sep 20 14:31:48 2012
@@ -59,6 +59,14 @@ public class ToChildBlockJoinQuery exten
   private final Query origParentQuery;
   private final boolean doScores;
 
+  /**
+   * Create a ToChildBlockJoinQuery.
+   * 
+   * @param parentQuery Query that matches parent documents
+   * @param parentsFilter Filter (must produce FixedBitSet
+   * per-segment) identifying the parent documents.
+   * @param doScores true if parent scores should be calculated
+   */
   public ToChildBlockJoinQuery(Query parentQuery, Filter parentsFilter, boolean doScores) {
     super();
     this.origParentQuery = parentQuery;

Modified: lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinCollector.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinCollector.java?rev=1388044&r1=1388043&r2=1388044&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinCollector.java (original)
+++ lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinCollector.java Thu Sep 20 14:31:48 2012
@@ -99,7 +99,7 @@ public class ToParentBlockJoinCollector 
   private int totalHitCount;
   private float maxScore = Float.NaN;
 
-  /*  Creates a ToParentBlockJoinCollector.  The provided sort must
+  /**  Creates a ToParentBlockJoinCollector.  The provided sort must
    *  not be null.  If you pass true trackScores, all
    *  ToParentBlockQuery instances must not use
    *  ScoreMode.None. */

Modified: lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinQuery.java
URL: http://svn.apache.org/viewvc/lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinQuery.java?rev=1388044&r1=1388043&r2=1388044&view=diff
==============================================================================
--- lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinQuery.java (original)
+++ lucene/dev/trunk/lucene/join/src/java/org/apache/lucene/search/join/ToParentBlockJoinQuery.java Thu Sep 20 14:31:48 2012
@@ -100,7 +100,7 @@ public class ToParentBlockJoinQuery exte
    * 
    * @param childQuery Query matching child documents.
    * @param parentsFilter Filter (must produce FixedBitSet
-   * per-seegment) identifying the parent documents.
+   * per-segment) identifying the parent documents.
    * @param scoreMode How to aggregate multiple child scores
    * into a single parent score.
    **/