Added documentation

[taxeditor.git] / eu.etaxonomy.taxeditor.store / src / main / java / eu / etaxonomy / taxeditor / model / DefaultTermComparator.java

diff --git a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/model/DefaultTermComparator.java b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/model/DefaultTermComparator.java
index a6a72d039a9e5a12dc1930a8308c0af6f44147b4..16c07dfc94a28de8aad4ddcbd6c0677db02e4496 100644 (file)
--- a/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/model/DefaultTermComparator.java
+++ b/eu.etaxonomy.taxeditor.store/src/main/java/eu/etaxonomy/taxeditor/model/DefaultTermComparator.java
@@ -15,6 +15,10 @@ import eu.etaxonomy.cdm.model.common.DefinedTermBase;
 import eu.etaxonomy.taxeditor.store.CdmStore;
 
 /**
+ * Implements a {@link Comparator} for {@link DefinedTermBase} objects based on the term's label.
+ * The compare algorithm compares a term's label. Example: If used on an unsorted list of terms, the
+ * list will be alphabetically  sorted by label afterwards.
+ * 
  * @author n.hoffmann
  * @date Jan 18, 2012
  *