X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=blobdiff_plain;f=opendaylight%2Fsal%2Fyang-prototype%2Fyang%2Fyang-model-api%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fyang%2Fmodel%2Fapi%2FDeviation.java;h=8745dda8ba63112c4e221a17e8aa8260b796c94d;hp=b3b2c06caa03502c904351d27e1d90a9b4d1e1fa;hb=82d65e5729893688d4daa0a9d6a55d90d30d6899;hpb=626c9943156ed658f0a4cf11858ccc19b9c316cf

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 b3b2c06caa..8745dda8ba 100644
--- 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 @@
  */
 package org.opendaylight.controller.yang.model.api;
 
+/**
+ * Interface describing YANG 'deviation' statement.
+ * <p>
+ * The 'deviation' statement defines a hierarchy of a module that the device
+ * does not implement faithfully. Deviations define the way a device deviate
+ * from a standard.
+ * </p>
+ */
 public interface Deviation {
 
+    /**
+     * Enum describing YANG deviation 'deviate' statement. It defines how the
+     * device's implementation of the target node deviates from its original
+     * definition.
+     */
     enum Deviate {
         NOT_SUPPORTED, ADD, REPLACE, DELETE
     }
 
+    /**
+     * @return SchemaPath that identifies the node in the schema tree where a
+     *         deviation from the module occurs.
+     */
     SchemaPath getTargetPath();
 
+    /**
+     * @return deviate statement of this deviation
+     */
     Deviate getDeviate();
 
+    /**
+     * @return textual cross-reference to an external document that provides
+     *         additional information relevant to this node.
+     */
     String getReference();
 
 }