OpenFLow plugin & SAL API documentation

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

diff --git a/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IPluginOutConnectionService.java b/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IPluginOutConnectionService.java
index b602d61952e7778a7f6fb5d66a14e9338102a030..456acf016684cdfa4ece97918c03c89240c26bf2 100644 (file)
--- a/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IPluginOutConnectionService.java
+++ b/opendaylight/sal/connection/api/src/main/java/org/opendaylight/controller/sal/connection/IPluginOutConnectionService.java
@@ -10,10 +10,15 @@ package org.opendaylight.controller.sal.connection;
 
 import org.opendaylight.controller.sal.core.Node;
 
+/**
+ * The interface describes methods to be implemented by SAL connection service
+ */
 public interface IPluginOutConnectionService {
     /**
      * Method to test if a node is local to a controller.
      *
+     * @param node
+     *            the given node {@link org.opendaylight.controller.sal.core.Node}
      * @return true if node is local to this controller. false otherwise.
      */
     public boolean isLocal(Node node);