OpenFLow plugin & SAL API documentation

[controller.git] / opendaylight / sal / connection / api / src / main / java / org / opendaylight / controller / sal / connection / IConnectionService.java

diff --git a/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IConnectionService.java b/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IConnectionService.java
index 685738c7e7420bc0f25aad9771268512a2aa1a36..ff63cf7578293a0828ac5e2e062566352d1c85ca 100644 (file)
--- a/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IConnectionService.java
+++ b/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IConnectionService.java
@@ -27,11 +27,10 @@ public interface IConnectionService {
      * plugins and is an opaque value for SAL. Typical values keyed inside this params are
      * Management IP-Address, Username, Password, Security Keys, etc...
      *
-     *  @return Node
+     * @return Node {@link org.opendaylight.controller.sal.core.Node}
      */
     public Node connect (String type, String connectionIdentifier, Map<ConnectionConstants, String> params);
 
-
     /**
      * Discover the node type and Connect to the first plugin that is able to connect with the specified parameters.
      *
@@ -41,7 +40,7 @@ public interface IConnectionService {
      * plugins and is an opaque value for SAL. Typical values keyed inside this params are
      * Management IP-Address, Username, Password, Security Keys, etc...
      *
-     *  @return Node
+     * @return Node {@link org.opendaylight.controller.sal.core.Node}
      */
     public Node connect (String connectionIdentifier, Map<ConnectionConstants, String> params);
 
@@ -49,12 +48,16 @@ public interface IConnectionService {
      * Disconnect a Node that is connected to this Controller.
      *
      * @param node
-     * @param flow
+     *            the node {@link org.opendaylight.controller.sal.core.Node}
+     * @return Status {@link org.opendaylight.controller.sal.utils.Status}
      */
     public Status disconnect(Node node);
 
     /**
      * View Change notification
+     *
+     * @param node
+     *            the node {@link org.opendaylight.controller.sal.core.Node}
      */
     public void notifyNodeDisconnectFromMaster(Node node);