Update comments for JavaDoc

Added comments for the followings interfaces: IForwardingStaticRouting, IRouting.
Removed the method saveConfig() from IForwardingStaticRouting since it is not a public method and is only use privately.

Change-Id: I15e15916287fe05a02e31536e064fb78c827c26a
Signed-off-by: Chi-Vien Ly <chivly@cisco.com>

diff --git a/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/IForwardingStaticRouting.java b/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/IForwardingStaticRouting.java
index 9b9c0b0d812fa943a39e200a69c79eb72cb8d7a7..5fabb2629de3ca31a96a348fc94478d2e33c698f 100644 (file)
--- a/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/IForwardingStaticRouting.java
+++ b/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/IForwardingStaticRouting.java
@@ -18,6 +18,11 @@ import java.util.concurrent.ConcurrentMap;
  */
 import org.opendaylight.controller.sal.utils.Status;
 
  */
 import org.opendaylight.controller.sal.utils.Status;
 

+/**
+ * 
+ * This Interface provides APIs to manage and query the static routes
+ *
+ */

 public interface IForwardingStaticRouting {
 
     /**
 public interface IForwardingStaticRouting {
 
     /**


@@ -48,11 +53,4 @@ public interface IForwardingStaticRouting {
      * If the operation is successful, the return string will be "SUCCESS"
      */
     public Status removeStaticRoute(String name);
      * If the operation is successful, the return string will be "SUCCESS"
      */
     public Status removeStaticRoute(String name);

-
-    /**
-     * Saves the config
-     * @return a text string indicating the result of the operation.
-     * If the operation is successful, the return string will be "Success"
-     */
-    Status saveConfig();

 }
 }

diff --git a/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/internal/StaticRoutingImplementation.java b/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/internal/StaticRoutingImplementation.java
index ad6ea6bc105328691f3221fa6ccbe1b7302ad7bb..1ac923c15ee266b737e202e62373fad4c8d0bc79 100644 (file)
--- a/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/internal/StaticRoutingImplementation.java
+++ b/opendaylight/forwarding/staticrouting/src/main/java/org/opendaylight/controller/forwarding/staticrouting/internal/StaticRoutingImplementation.java
@@ -131,8 +131,8 @@ public class StaticRoutingImplementation implements IfNewHostNotify,
         }
     }
 
         }
     }
 

-    @Override
-    public Status saveConfig() {
+    
+    private Status saveConfig() {

         // Publish the save config event to the cluster nodes
         configSaveEvent.put(new Date().getTime(), SAVE);
         return saveConfigInternal();
         // Publish the save config event to the cluster nodes
         configSaveEvent.put(new Date().getTime(), SAVE);
         return saveConfigInternal();

diff --git a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/routing/IRouting.java b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/routing/IRouting.java
index 6d246c6d2313f266185f4ed91cfc3a13b68dbd93..80950e66a5289fffca8ebbc12fd0fec31ae01525 100644 (file)
--- a/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/routing/IRouting.java
+++ b/opendaylight/sal/api/src/main/java/org/opendaylight/controller/sal/routing/IRouting.java
@@ -15,6 +15,10 @@ import org.opendaylight.controller.sal.core.Edge;
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.core.Path;
 
 import org.opendaylight.controller.sal.core.Node;
 import org.opendaylight.controller.sal.core.Path;
 

+/**
+ * This interface provides APIs to manage and query the routing information
+  *
+ */

 public interface IRouting {
 
     /**
 public interface IRouting {
 
     /**