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

diff --git a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/RpcDefinition.java b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/RpcDefinition.java
index a4c784e0cd7e096eba33b1266333d868c25ecf70..5ce453dd38887c092c2ee369b238de4aa243df9b 100644 (file)
--- a/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/RpcDefinition.java
+++ b/opendaylight/sal/yang-prototype/yang/yang-model-api/src/main/java/org/opendaylight/controller/yang/model/api/RpcDefinition.java
@@ -9,13 +9,36 @@ package org.opendaylight.controller.yang.model.api;
 \r
 import java.util.Set;\r
 \r
+/**\r
+ * Interface describing YANG 'rpc' statement.\r
+ * <p>\r
+ * The rpc statement defines an rpc node in the schema tree. Under the rpc node,\r
+ * a schema node with the name 'input', and a schema node with the name 'output'\r
+ * are also defined.\r
+ * </p>\r
+ */\r
 public interface RpcDefinition extends SchemaNode {\r
 \r
+    /**\r
+     * @return Set of type definitions declared under this rpc statement.\r
+     */\r
     Set<TypeDefinition<?>> getTypeDefinitions();\r
 \r
+    /**\r
+     * @return Set of grouping statements declared under this rpc statement.\r
+     */\r
     Set<GroupingDefinition> getGroupings();\r
 \r
+    /**\r
+     * @return Definition of input parameters to the RPC operation. The\r
+     *         substatements of input define nodes under the RPC's input node.\r
+     */\r
     ContainerSchemaNode getInput();\r
 \r
+    /**\r
+     * @return Definition of output parameters to the RPC operation. The\r
+     *         substatements of output define nodes under the RPC's output node.\r
+     */\r
     ContainerSchemaNode getOutput();\r
+\r
 }\r