More javadocs added to yang-model-api.

[controller.git] / opendaylight / sal / yang-prototype / yang / yang-model-api / src / main / java / org / opendaylight / controller / yang / model / api / UsesNode.java

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/UsesNode.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/UsesNode.java
index 91fde5bd5c9bc17f1229a7405410500af1125aaa..e76f5e81318120f0af134446b1982ef3e1eef226 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/UsesNode.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/UsesNode.java
@@ -12,11 +12,31 @@ import java.util.Set;
 \r
 public interface UsesNode {\r
 \r
+    /**\r
+     * @return path to 'grouping' on which this 'uses' statement points\r
+     */\r
     SchemaPath getGroupingPath();\r
-    \r
+\r
+    /**\r
+     * @return Set of augment statements defined under this uses node\r
+     */\r
     Set<AugmentationSchema> getAugmentations();\r
-    \r
+\r
+    /**\r
+     * Returns <code>true</code> if the data node was added by augmentation,\r
+     * otherwise returns <code>false</code>\r
+     *\r
+     * @return <code>true</code> if the data node was added by augmentation,\r
+     *         otherwise returns <code>false</code>\r
+     */\r
     boolean isAugmenting();\r
-    \r
+\r
+    /**\r
+     * Some of the properties of each node in the grouping can be refined with\r
+     * the "refine" statement.\r
+     *\r
+     * @return Map, where key is schema path of refined node and value is\r
+     *         refined node\r
+     */\r
     Map<SchemaPath, SchemaNode> getRefines();\r
 }\r