diff --git a/CHANGES.txt b/CHANGES.txt index 51ea232196d..34bf18f8762 100644 --- a/CHANGES.txt +++ b/CHANGES.txt @@ -402,6 +402,8 @@ Other Changes 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: diff --git a/src/java/org/apache/solr/update/DocumentBuilder.java b/src/java/org/apache/solr/update/DocumentBuilder.java index 1369ee78978..8be1076870e 100644 --- a/src/java/org/apache/solr/update/DocumentBuilder.java +++ b/src/java/org/apache/solr/update/DocumentBuilder.java @@ -74,15 +74,44 @@ public class DocumentBuilder { } } - + /** + * 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) {