HSEARCH-2872 Improve javadocs of IndexedTypeSet and fix some typos

hibernate · Sep 12, 2017 · df7a75b · df7a75b
1 parent bad7e91
commit df7a75b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/engine/src/main/java/org/hibernate/search/spi/IndexedTypeMap.java b/engine/src/main/java/org/hibernate/search/spi/IndexedTypeMap.java
@@ -18,7 +18,7 @@
  * In an ideal world, we will expose less methods than what is currently listed:
  * some methods have been introduced as Deprecated since the beginning as the plan
  * is to eventually remove them; they currently exist merely to allow a
- * pratical migration of code to the new approach in smaller, testable steps.
+ * practical migration of code to the new approach in smaller, testable steps.
  *
  * @author Sanne Grinovero
  */

diff --git a/engine/src/main/java/org/hibernate/search/spi/IndexedTypeSet.java b/engine/src/main/java/org/hibernate/search/spi/IndexedTypeSet.java
@@ -8,14 +8,18 @@
 
 import java.util.Set;
 
+/**
+ * Represents a set of IndexedTypeIdentifier instances.
+ * Could be an empty set, a singleton set or actually multiple type identifiers.
+ */
 public interface IndexedTypeSet extends Iterable<IndexedTypeIdentifier> {
 
 	int size();
 
 	boolean isEmpty();
 
 	/**
-	 * Return the set of the unrelying POJOs.
+	 * Return the set of the underlying POJOs.
 	 * @deprecated This only exists to facilitate an iterative integration, and will be removed ASAP.
 	 */
 	@Deprecated