Fixed tests. Added javadocs to yang-model-api.

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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/AugmentationSchema.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/AugmentationSchema.java
index 16e8b9e84639820d046e67b6b380ddadfb5f846a..31e0ad682d2b2b9e92473b103bb5d94191257bc1 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/AugmentationSchema.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/AugmentationSchema.java
@@ -7,20 +7,42 @@
  */\r
 package org.opendaylight.controller.yang.model.api;\r
 \r
-import java.util.Set;\r
-\r
+/**\r
+ * AugmentationSchema represents augment definition. The "augment" statement\r
+ * allows a module or submodule to add to the schema tree defined in an external\r
+ * module, or the current module and its submodules, and to add to the nodes\r
+ * from a grouping in a "uses" statement.\r
+ */\r
 public interface AugmentationSchema extends DataNodeContainer {\r
 \r
+    /**\r
+     * @return when statement\r
+     */\r
     RevisionAwareXPath getWhenCondition();\r
 \r
+    /**\r
+     * @return textual description of this augment.\r
+     */\r
     String getDescription();\r
 \r
+    /**\r
+     * @return textual cross-reference to an external document that provides\r
+     *         additional information relevant to this node.\r
+     */\r
     String getReference();\r
 \r
+    /**\r
+     * @return actual status of this node.\r
+     */\r
     Status getStatus();\r
 \r
+    /**\r
+     * @return SchemaPath that identifies a node in the schema tree. This node\r
+     *         is called the augment's target node. The target node MUST be\r
+     *         either a container, list, choice, case, input, output, or\r
+     *         notification node. It is augmented with the nodes defined as\r
+     *         child nodes of this AugmentationSchema.\r
+     */\r
     SchemaPath getTargetPath();\r
 \r
-    Set<UsesNode> getUses();\r
-\r
 }\r