svn commit: r1299386 - in /lucene/dev/branches/branch_3x: ./ lucene/ lucene/core/src/java/org/apache/lucene/index/FieldInfos.java

[rm...@apache.org]

Author: rmuir
Date: Sun Mar 11 16:15:25 2012
New Revision: 1299386

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

Modified:
    lucene/dev/branches/branch_3x/   (props changed)
    lucene/dev/branches/branch_3x/lucene/   (props changed)
    lucene/dev/branches/branch_3x/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java

Modified: lucene/dev/branches/branch_3x/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java
URL: http://svn.apache.org/viewvc/lucene/dev/branches/branch_3x/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java?rev=1299386&r1=1299385&r2=1299386&view=diff
==============================================================================
--- lucene/dev/branches/branch_3x/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java (original)
+++ lucene/dev/branches/branch_3x/lucene/core/src/java/org/apache/lucene/index/FieldInfos.java Sun Mar 11 16:15:25 2012
@@ -221,6 +221,12 @@ public final class FieldInfos implements
     return fi;
   }
 
+  /**
+   * lookup the number of a field by name.
+   * 
+   * @param fieldName field's name
+   * @return number of field, or -1 if it does not exist.
+   */
   public int fieldNumber(String fieldName) {
     FieldInfo fi = fieldInfo(fieldName);
     return (fi != null) ? fi.number : -1;
@@ -256,10 +262,16 @@ public final class FieldInfos implements
     return byNumber.iterator();
   }
 
+  /**
+   * @return number of fields
+   */
   public int size() {
     return byNumber.size();
   }
 
+  /**
+   * @return true if at least one field has any vectors
+   */
   public boolean hasVectors() {
     boolean hasVectors = false;
     for (int i = 0; i < size(); i++) {