From: Chi-Vien Ly <chivly@cisco.com>
Date: Wed, 1 May 2013 04:43:15 +0000 (-0700)
Subject: Update comments for JavaDoc
X-Git-Tag: releasepom-0.1.0~509^2
X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?p=controller.git;a=commitdiff_plain;h=67050bffbd1507578dab73ad2e09735d2810f5b4;hp=6af337195781fc17e61d49250840ff60a19534f3;ds=sidebyside

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 9b9c0b0d81..5fabb2629d 100644
--- 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;
 
+/**
+ * 
+ * This Interface provides APIs to manage and query the static routes
+ *
+ */
 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);
-
-    /**
-     * 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 ad6ea6bc10..1ac923c15e 100644
--- 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();
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 6d246c6d23..80950e66a5 100644
--- 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;
 
+/**
+ * This interface provides APIs to manage and query the routing information
+  *
+ */
 public interface IRouting {
 
     /**