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 2013/01/06 14:40:51 UTC
svn commit: r1429521 - in /lucene/dev/branches/branch_4x: ./ lucene/
lucene/core/
lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
Author: rmuir
Date: Sun Jan 6 13:40:51 2013
New Revision: 1429521
URL: http://svn.apache.org/viewvc?rev=1429521&view=rev
Log:
javadocs
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/document/DocumentStoredFieldVisitor.java
lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java?rev=1429521&r1=1429520&r2=1429521&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/document/DocumentStoredFieldVisitor.java Sun Jan 6 13:40:51 2013
@@ -38,12 +38,15 @@ public class DocumentStoredFieldVisitor
private final Document doc = new Document();
private final Set<String> fieldsToAdd;
- /** Load only fields named in the provided <code>Set<String></code>. */
+ /**
+ * Load only fields named in the provided <code>Set<String></code>.
+ * @param fieldsToAdd Set of fields to load, or <code>null</code> (all fields).
+ */
public DocumentStoredFieldVisitor(Set<String> fieldsToAdd) {
this.fieldsToAdd = fieldsToAdd;
}
- /** Load only fields named in the provided <code>Set<String></code>. */
+ /** Load only fields named in the provided fields. */
public DocumentStoredFieldVisitor(String... fields) {
fieldsToAdd = new HashSet<String>(fields.length);
for(String field : fields) {
Modified: lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java?rev=1429521&r1=1429520&r2=1429521&view=diff
==============================================================================
--- lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java (original)
+++ lucene/dev/branches/branch_4x/lucene/core/src/java/org/apache/lucene/search/IndexSearcher.java Sun Jan 6 13:40:51 2013
@@ -180,17 +180,26 @@ public class IndexSearcher {
return reader;
}
- /** Sugar for <code>.getIndexReader().document(docID)</code> */
+ /**
+ * Sugar for <code>.getIndexReader().document(docID)</code>
+ * @see IndexReader#document(int)
+ */
public Document doc(int docID) throws IOException {
return reader.document(docID);
}
- /** Sugar for <code>.getIndexReader().document(docID, fieldVisitor)</code> */
+ /**
+ * Sugar for <code>.getIndexReader().document(docID, fieldVisitor)</code>
+ * @see IndexReader#document(int, StoredFieldVisitor)
+ */
public void doc(int docID, StoredFieldVisitor fieldVisitor) throws IOException {
reader.document(docID, fieldVisitor);
}
- /** Sugar for <code>.getIndexReader().document(docID, fieldsToLoad)</code> */
+ /**
+ * Sugar for <code>.getIndexReader().document(docID, fieldsToLoad)</code>
+ * @see IndexReader#document(int, Set)
+ */
public final Document document(int docID, Set<String> fieldsToLoad) throws IOException {
return reader.document(docID, fieldsToLoad);
}