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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Status.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Status.java
index 9a49d79d323a686d05e91a037c56c68c861e927b..39aa0c847283a5ba6f628b1a3f23d3a64ab71720 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Status.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/Status.java
@@ -7,6 +7,28 @@
  */\r
 package org.opendaylight.controller.yang.model.api;\r
 \r
+/**\r
+ * Enum describing YANG 'status' statement. If no status is specified, the\r
+ * default is CURRENT.\r
+ */\r
 public enum Status {\r
-    CURRENT, DEPRECATED, OBSOLETE\r
+\r
+    /**\r
+     * CURRENT means that the definition is current and valid.\r
+     */\r
+    CURRENT,\r
+\r
+    /**\r
+     * DEPRECATED indicates an obsolete definition, but it permits new/\r
+     * continued implementation in order to foster interoperability with\r
+     * older/existing implementations.\r
+     */\r
+    DEPRECATED,\r
+\r
+    /**\r
+     * OBSOLETE means the definition is obsolete and SHOULD NOT be implemented\r
+     * and/or can be removed from implementations.\r
+     */\r
+    OBSOLETE\r
+\r
 }\r