documentation on polytomous key + node

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKey.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKey.java
index 180de70280f353765de6307047cc63e90713f496..8998ebfafe5dca98b6b57dbe5e9d3ae412f3790b 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKey.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKey.java
@@ -47,23 +47,20 @@ import eu.etaxonomy.cdm.strategy.cache.description.PolytomousKeyDefaultCacheStra
 import eu.etaxonomy.cdm.strategy.generate.PolytomousKeyGenerator;\r
 \r
 /**\r
- * The class allowing the representation of single-access fixed dichotomous or\r
- * polytomous decision keys used to identify {@link SpecimenOrObservationBase\r
- * specimens or observations} (this means to assign {@link Taxon taxa} to). The\r
- * key may be written by an author or may be generated by the\r
- * {@link PolytomousKeyGenerator}. The different paths to the taxa are expressed\r
+ * This class represents a fixed single-access key (dichotomous or\r
+ * polytomous) used to identify (assign a {@link Taxon taxon} to) a {@link SpecimenOrObservationBase\r
+ * specimen or observation}. The key may be written manually or may be generated automatically\r
+ * e.g. by the {@link PolytomousKeyGenerator}. The different paths to the taxa are expressed\r
  * by a decision graph consisting of {@link PolytomousKeyNode\r
  * PolytomousKeyNodes}. The root node of such graph is accessible by\r
- * {@link #getRoot()}. Please refer to {@link PolytomousKeyNode} for detailed\r
- * documentation on this decision graph please\r
+ * {@link #getRoot()}. Refer to {@link PolytomousKeyNode} for detailed\r
+ * documentation on the decision graph structure.\r
  * \r
  * @author h.fradin\r
  * @created 13.08.2009\r
- * @version 1.0\r
  * \r
  * @author a.mueller\r
- * @created 08.11.2010\r
- * @version 2.0\r
+ * @version 2.0 (08.11.2010)\r
  */\r
 @XmlAccessorType(XmlAccessType.FIELD)\r
 @XmlType(name = "PolytomousKey", propOrder = { "coveredTaxa", "taxonomicScope",\r

diff --git a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKeyNode.java b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKeyNode.java
index bee01c1d2676f61b006eaf3014fb2ced34f129cf..8de25cf6caad13cedfed4d34dae7c58252c1d623 100644 (file)
--- a/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKeyNode.java
+++ b/cdmlib-model/src/main/java/eu/etaxonomy/cdm/model/description/PolytomousKeyNode.java
@@ -118,6 +118,10 @@ import eu.etaxonomy.cdm.model.taxon.Taxon;
  * this rare to avoid a more complicated <code>List<Taxon></code> structure for the standard
  * case.</li>
  * 
+ * The {@link PolytomousKey#getRoot() root node of the key} may represent the entry point
+ * question or feature but does naturally neither have a statement nor a linked taxon as 
+ * there is no prior decision yet. 
+ * 
  * <h4>Notes</h4>
  * <p>
  * A polytomous key node can be referenced from multiple other nodes via the