commit 87ae1d9a30f5a318c10748d79decbc8a612c3ddf
author Thomas Vachuska <tom@onlab.us> Wed Aug 19 17:39:11 2015 -0700
committer Gerrit Code Review <gerrit@onlab.us> Thu Aug 20 00:46:33 2015 +0000
tree 8763fe4bf4f006c185d69e80f5d2659344af6c08
parent 483d0a2245472f63a4425c0c0abf2d28b9ded2b4

Fixed javadoc warnings & added a few deprecations.

Change-Id: I89205b08bc5fcbfed769c489609a46d420ee227e

web/api/src/main/java/org/onosproject/rest/resources/ApiDocResource.java

diff --git a/web/api/src/main/java/org/onosproject/rest/resources/ApiDocResource.java b/web/api/src/main/java/org/onosproject/rest/resources/ApiDocResource.java
index 0ad4fc6..804f05e 100644
--- a/web/api/src/main/java/org/onosproject/rest/resources/ApiDocResource.java
+++ b/web/api/src/main/java/org/onosproject/rest/resources/ApiDocResource.java
@@ -107,6 +107,8 @@
      * Get Swagger UI main index page.
      *
      * @return 200 OK
+     * @throws IOException if unable to get index resource
+     * @throws URISyntaxException if unable to create redirect URI
      */
     @GET
     @Path("/")
@@ -119,6 +121,7 @@
      * Get Swagger UI main index page.
      *
      * @return 200 OK
+     * @throws IOException if unable to get index resource
      */
     @GET
     @Path("index.html")
@@ -155,7 +158,9 @@
     /**
      * Get Swagger UI resource.
      *
+     * @param resource path of the resource
      * @return 200 OK
+     * @throws IOException if unable to get named resource
      */
     @GET
     @Path("{resource: .*}")

web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java

diff --git a/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java b/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java
index ee608b7..dd9b9fc 100644
--- a/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java
+++ b/web/api/src/main/java/org/onosproject/rest/resources/ClusterWebResource.java
@@ -77,6 +77,7 @@
      *
      * @param config cluster definition
      * @return 200 OK
+     * @throws IOException to signify bad request
      */
     @POST
     @Path("configuration")

web/api/src/main/java/org/onosproject/rest/resources/ComponentConfigWebResource.java

diff --git a/web/api/src/main/java/org/onosproject/rest/resources/ComponentConfigWebResource.java b/web/api/src/main/java/org/onosproject/rest/resources/ComponentConfigWebResource.java
index 4adb6c5..468a376 100644
--- a/web/api/src/main/java/org/onosproject/rest/resources/ComponentConfigWebResource.java
+++ b/web/api/src/main/java/org/onosproject/rest/resources/ComponentConfigWebResource.java
@@ -82,7 +82,9 @@
      * Sets only the properties present in the JSON request.
      *
      * @param component component name
+     * @param request   JSON configuration
      * @return 200 OK
+     * @throws IOException to signify bad request
      */
     @POST
     @Path("{component}")
@@ -100,7 +102,9 @@
      * Clears only the properties present in the JSON request.
      *
      * @param component component name
+     * @param request   JSON configuration
      * @return 200 OK
+     * @throws IOException to signify bad request
      */
     @DELETE
     @Path("{component}")