HSEARCH-2387 Fix javadoc

Author: DavideD

elasticsearch/src/main/java/org/hibernate/search/elasticsearch/cfg/DynamicType.java

@@ -9,9 +9,10 @@
 /**
  * Configuration values for Elasticsearch "dynamic" attribute values.
  * <p>
- * Defines the behaviour when a document contains an unrecognized field.
- *
- * @see <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic.html">Elasticsearch mapping:
+ * Defines the behaviour when a document contains a field the wasn't define in the index schema.
+ * <p>
+ * More details on the Elasticsearch documentation:
+ * <a href="https://www.elastic.co/guide/en/elasticsearch/reference/current/dynamic.html">Elasticsearch mapping:
  * dynamic</a>
  *
  * @author Davide D'Alto

elasticsearch/src/main/java/org/hibernate/search/elasticsearch/cfg/ElasticsearchEnvironment.java

@@ -225,14 +225,15 @@ public static final class Defaults {
 	public static final String SCROLL_TIMEOUT = "elasticsearch.scroll_timeout";
 
 	/**
-	 * Property for specifying the behaviour when Elasticsearch encounters a previously unknown field in a document.
+	 * Equivalent to elasticsearch "dynamic", define what to do when a document contains a field which was not declared
+	 * in the index schema.
 	 * <p>
 	 * Possible values are:
 	 * <p>
 	 * <ul>
-	 *   <li>{@code true}: Add new fields dynamically</li>
-	 *   <li>{@code false}: Ignore new fields</li>
-	 *   <li>{@code strict}: Throw an exception if an unknown field is encountered</li>
+	 * <li>{@code true}: Add new fields dynamically</li>
+	 * <li>{@code false}: Ignore new fields</li>
+	 * <li>{@code strict}: Throw an exception</li>
 	 * </ul>
 	 * <p>
 	 * Defaults to {@code strict}.

engine/src/main/java/org/hibernate/search/bridge/spi/FieldMetadataCreationContext.java

@@ -35,10 +35,10 @@ public interface FieldMetadataCreationContext {
 	FieldMetadataCreationContext sortable(boolean sortable);
 
 	/**
-	 * Give access to properties that are backend specific
+	 * Gives access to properties that are specific to an indexing technology.
 	 *
-	 * @param backendType the selected backend.
+	 * @param indexTechnology the selected index technology.
 	 * @return the context for the fluent API related to the select backend.
 	 */
-	<T extends FieldMetadataCreationContext> T mappedOn(Class<T> backendType);
+	<T extends FieldMetadataCreationContext> T mappedOn(Class<T> indexTechnology);
 }

engine/src/main/java/org/hibernate/search/bridge/spi/FieldType.java

@@ -51,7 +51,7 @@ public enum FieldType {
 	DOUBLE,
 
 	/**
-	 * An object field, a generic object that doesn't have a unique definition in all the backends.
+	 * A composite object that will benefit from using a different encoding on each indexing technology.
 	 * <p>
 	 * For example, it could identify a field that should be mapped in Elasticsearch as an inner object and in Lucene
 	 * as multiple string fields (Lucene does not have inner objects).

engine/src/main/java/org/hibernate/search/engine/metadata/impl/BridgeDefinedField.java

@@ -29,8 +29,8 @@ public class BridgeDefinedField {
 	private final FieldType type;
 
 	/*
-	 * Backends have specific field properties (Elastic search dynamic mapping for example). this map will group the
-	 * properties per backend.
+	 * This map will group bridge defined field properties that make sense only for specific index managers.
+	 * For example, in Elasticsearch one can specify the mapping as dynamic.
 	 */
 	private Map<Class<?>, Object> extra = new HashMap<>();
 
@@ -84,12 +84,12 @@ public <T> void add(Class<T> backendBridgeDefineFieldClass, T backendBridgeDefin
 	}
 
 	/**
-	 * Returns the object containing the properties of the field for the specific class.
+	 * Get the bridge defined field of the specific class.
 	 *
-	 * @param backendBridgeDefineFieldClass the type of the object containing the properties of the field
+	 * @param bridgeDefineFieldClass the type of the object containing the properties of the field
 	 * @return the object containing the properties of the field
 	 */
-	public <T> T mappedOn(Class<T> backendBridgeDefineFieldClass) {
-		return backendBridgeDefineFieldClass.cast( extra.get( backendBridgeDefineFieldClass ) );
+	public <T> T mappedOn(Class<T> bridgeDefineFieldClass) {
+		return bridgeDefineFieldClass.cast( extra.get( bridgeDefineFieldClass ) );
 	}
 }