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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ModuleImport.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ModuleImport.java
index 37237dd057d8c112fb4eae6a4b76661d76cf2353..431479858914755b1c3a347bf31f8f79b7ae4415 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ModuleImport.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/ModuleImport.java
@@ -9,11 +9,28 @@ package org.opendaylight.controller.yang.model.api;
 \r
 import java.util.Date;\r
 \r
+/**\r
+ * Interface describing YANG 'import' statement.\r
+ * <p>\r
+ * The import statement makes definitions from one module available inside\r
+ * another module or submodule.\r
+ * </p>\r
+ */\r
 public interface ModuleImport {\r
 \r
+    /**\r
+     * @return Name of the module to import\r
+     */\r
     String getModuleName();\r
 \r
+    /**\r
+     * @return Revision of module to import\r
+     */\r
     Date getRevision();\r
 \r
+    /**\r
+     * @return Prefix used to point to imported module\r
+     */\r
     String getPrefix();\r
+\r
 }\r