svn commit: r651437 - in /lucene/solr/trunk: CHANGES.txt src/java/org/apache/solr/update/DocumentBuilder.java

[gs...@apache.org]

Author: gsingers
Date: Thu Apr 24 15:04:30 2008
New Revision: 651437

URL: http://svn.apache.org/viewvc?rev=651437&view=rev
Log:
SOLR-550: updated docs

Modified:
    lucene/solr/trunk/CHANGES.txt
    lucene/solr/trunk/src/java/org/apache/solr/update/DocumentBuilder.java

Modified: lucene/solr/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/CHANGES.txt?rev=651437&r1=651436&r2=651437&view=diff
==============================================================================
--- lucene/solr/trunk/CHANGES.txt (original)
+++ lucene/solr/trunk/CHANGES.txt Thu Apr 24 15:04:30 2008
@@ -402,6 +402,8 @@
 
 11. SOLR-531: Different exit code for rsyncd-start and snappuller if disabled (Thomas Peuss via billa)
 
+12. SOLR-550: Clarified DocumentBuilder addField javadocs (gsingers)
+
 Build
  1. SOLR-411.  Changed the names of the Solr JARs to use the defacto standard JAR names based on
     project-name-version.jar.  This yields, for example:

Modified: lucene/solr/trunk/src/java/org/apache/solr/update/DocumentBuilder.java
URL: http://svn.apache.org/viewvc/lucene/solr/trunk/src/java/org/apache/solr/update/DocumentBuilder.java?rev=651437&r1=651436&r2=651437&view=diff
==============================================================================
--- lucene/solr/trunk/src/java/org/apache/solr/update/DocumentBuilder.java (original)
+++ lucene/solr/trunk/src/java/org/apache/solr/update/DocumentBuilder.java Thu Apr 24 15:04:30 2008
@@ -74,15 +74,44 @@
     }
   }
 
-
+  /**
+   * Add the specified {@link org.apache.solr.schema.SchemaField} to the document.  Does not invoke the copyField mechanism.
+   * @param sfield The {@link org.apache.solr.schema.SchemaField} to add
+   * @param val The value to add
+   * @param boost The boost factor
+   *
+   * @see #addField(String, String)
+   * @see #addField(String, String, float)
+   * @see #addSingleField(org.apache.solr.schema.SchemaField, String, float)
+   */
   public void addField(SchemaField sfield, String val, float boost) {
     addSingleField(sfield,val,boost);
   }
 
+  /**
+   * Add the Field and value to the document, invoking the copyField mechanism
+   * @param name The name of the field
+   * @param val The value to add
+   *
+   * @see #addField(String, String, float)
+   * @see #addField(org.apache.solr.schema.SchemaField, String, float)
+   * @see #addSingleField(org.apache.solr.schema.SchemaField, String, float)
+   */
   public void addField(String name, String val) {
     addField(name, val, 1.0f);
   }
 
+  /**
+   * Add the Field and value to the document with the specified boost, invoking the copyField mechanism
+   * @param name The name of the field.
+   * @param val The value to add
+   * @param boost The boost
+   *
+   * @see #addField(String, String)
+   * @see #addField(org.apache.solr.schema.SchemaField, String, float)
+   * @see #addSingleField(org.apache.solr.schema.SchemaField, String, float)
+   *
+   */
   public void addField(String name, String val, float boost) {
     SchemaField sfield = schema.getFieldOrNull(name);
     if (sfield != null) {