Clarify ActionSpec documentation

The documentation hints at wildcard InstanceIdentifier, but people have
trouble with the concept and what it means. Clarify that a bit.

JIRA: MDSAL-721
Change-Id: I9af71fbbfd2d27b4e4c4c12077975be1671647e3
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ActionSpec.java b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ActionSpec.java
index 206fed3f48c820a04eae313a803b1654028e7e4f..a42c0725911f5495fd047b4bed5bbad7c702ea63 100644 (file)
--- a/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ActionSpec.java
+++ b/binding/mdsal-binding-api/src/main/java/org/opendaylight/mdsal/binding/api/ActionSpec.java
@@ -26,7 +26,11 @@ import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdenti
 
 /**
  * A combination of an {@link Action} class and its corresponding instantiation wildcard, expressed as
- * an {@link InstanceIdentifier}. This glue is required because action interfaces are generated at the place of their
+ * an {@link InstanceIdentifier}. This means that {@code list}s are treated exactly as @{code container}s are, e.g.
+ * without a key value specification.
+ *
+ * <p>
+ * This glue is required because action interfaces are generated at the place of their
  * definition, most importantly in {@code grouping} and we actually need to bind to a particular instantiation (e.g. a
  * place where {@code uses} references that grouping).
  *