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 / Deviation.java

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Deviation.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Deviation.java
index b3b2c06caa03502c904351d27e1d90a9b4d1e1fa..8745dda8ba63112c4e221a17e8aa8260b796c94d 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Deviation.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Deviation.java
@@ -7,16 +7,40 @@
  */\r
 package org.opendaylight.controller.yang.model.api;\r
 \r
+/**\r
+ * Interface describing YANG 'deviation' statement.\r
+ * <p>\r
+ * The 'deviation' statement defines a hierarchy of a module that the device\r
+ * does not implement faithfully. Deviations define the way a device deviate\r
+ * from a standard.\r
+ * </p>\r
+ */\r
 public interface Deviation {\r
 \r
+    /**\r
+     * Enum describing YANG deviation 'deviate' statement. It defines how the\r
+     * device's implementation of the target node deviates from its original\r
+     * definition.\r
+     */\r
     enum Deviate {\r
         NOT_SUPPORTED, ADD, REPLACE, DELETE\r
     }\r
 \r
+    /**\r
+     * @return SchemaPath that identifies the node in the schema tree where a\r
+     *         deviation from the module occurs.\r
+     */\r
     SchemaPath getTargetPath();\r
 \r
+    /**\r
+     * @return deviate statement of this deviation\r
+     */\r
     Deviate getDeviate();\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