Update SystemLeafSetNode documentation 95/99695/1
authorRobert Varga <robert.varga@pantheon.tech>
Fri, 11 Feb 2022 15:55:24 +0000 (16:55 +0100)
committerRobert Varga <robert.varga@pantheon.tech>
Fri, 11 Feb 2022 15:55:24 +0000 (16:55 +0100)
The previous refactor failed to update the documentation to reflect
the difference from UserLeafSetNode. Fix that.

Change-Id: I46f749f6a88833c8cd893a22b194fc416138fdac
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
data/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/SystemLeafSetNode.java

index 2e1acad7cf2265f5c734710ecd2ec64731dbc277..9034864b1b783d3b03d973452a18c9ec02e29e1f 100644 (file)
@@ -8,13 +8,11 @@
 package org.opendaylight.yangtools.yang.data.api.schema;
 
 /**
- * Node representing set of simple leaf nodes. Node containing instances of {@link LeafSetEntryNode}.
+ * {@link LeafSetNode} which does not preserve user-supplied ordering. This node represents a data instance of
+ * a {@code leaf-list} without a {@code ordered-by user;} substatement, i.e. when the {@code leaf-list} is effectively
+ * {@code ordered-by system;}.
  *
- * <p>
- * Schema and semantics of this node are described by instance of
- * {@link org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode}.
- *
- * @param <T> Type of leaf node values.
+ * @param <T> Value type of Leaf entries
  */
 public interface SystemLeafSetNode<T> extends LeafSetNode<T>, OrderingAware.System {
     @Override