Improve ChoiceIn documentation

We have a few typos and the javadoc contains HTML entities. Clean this
up.

Change-Id: Ia09a63d2f55e41c748eceadc3a4d471325ee714e
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

diff --git a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/ChoiceIn.java b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/ChoiceIn.java
index aadbdce5d802c19b2740ddb13d37d6edc3f6592a..7f1f59042fe20aaf73a8dab213ec4020368788d3 100644 (file)
--- a/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/ChoiceIn.java
+++ b/binding/yang-binding/src/main/java/org/opendaylight/yangtools/yang/binding/ChoiceIn.java
@@ -16,18 +16,16 @@ package org.opendaylight.yangtools.yang.binding;
  * This marker interface is also inherited by interfaces generated for {@code case} statements, similarly marking those
  * interfaces as usable within scope when the statement which defined the {@code choice} statement. This allows us to
  * bind {@code grouping}s to their {@code uses} references within an (implicit or explicit) {@code case}, effectively
- * forming an addressing path from {@link DataRoot} or a {@link DataContainer} like this:
+ * forming an addressing path from {@link DataRoot} or a {@link DataContainer}. Given the following generated code:
+ * <pre>{@code
+ *   interface Grouping extends DataObject;
+ *   interface GroupingChild extends ChildOf<Grouping>;
  *
- * <pre>
- * interface Grouping extends DataObject
- * interface GroupingChild extends ChildOf&lt;Grouping&gt;
- *
- * interface Parent extends DataContainer
- * interface Choice implements Choice&lt;Parent&gt;
- * interface Case extends Choice, Grouping
- *
- * Parent -&gt; choiceOf -&gt; Case -&gt; childOf-&gt; GroupingChild
- * </pre>
+ *   interface Parent extends DataContainer;
+ *   interface Choice implements ChoiceIn<Parent>;
+ *   interface Case extends Choice, Grouping;
+ * }</pre>
+ * we can safely make the inference of {@code GroupingChild -> childOf -> Case -> choiceIn -> Parent}.
  *
  * @param <P> Parent container
  * @author Robert Varga