Thomas Vachuska
Committed by Gerrit Code Review

Fixed javadoc warnings & added a few deprecations.

Change-Id: I89205b08bc5fcbfed769c489609a46d420ee227e
...@@ -17,6 +17,9 @@ package org.onosproject.config; ...@@ -17,6 +17,9 @@ package org.onosproject.config;
17 17
18 /** 18 /**
19 * Service interface exported by the Network Configuration. 19 * Service interface exported by the Network Configuration.
20 + *
21 + * @deprecated in Drake; see org.onosproject.net.config
20 */ 22 */
23 +@Deprecated
21 public interface NetworkConfigService { 24 public interface NetworkConfigService {
22 } 25 }
......
...@@ -16,7 +16,10 @@ import org.onosproject.segmentrouting.config.NetworkConfig.SwitchConfig; ...@@ -16,7 +16,10 @@ import org.onosproject.segmentrouting.config.NetworkConfig.SwitchConfig;
16 * 16 *
17 * TODO: return immutable objects or defensive copies of network config so that 17 * TODO: return immutable objects or defensive copies of network config so that
18 * users of this API do not inadvertently or maliciously change network config. 18 * users of this API do not inadvertently or maliciously change network config.
19 + *
20 + * @deprecated in Drake; see org.onosproject.net.config
19 */ 21 */
22 +@Deprecated
20 public interface NetworkConfigService { 23 public interface NetworkConfigService {
21 24
22 /** 25 /**
......
...@@ -236,6 +236,8 @@ public abstract class Tools { ...@@ -236,6 +236,8 @@ public abstract class Tools {
236 * @param maxDelayBetweenRetries max delay between successive retries. The actual delay is randomly picked from 236 * @param maxDelayBetweenRetries max delay between successive retries. The actual delay is randomly picked from
237 * the interval (0, maxDelayBetweenRetries] 237 * the interval (0, maxDelayBetweenRetries]
238 * @return function 238 * @return function
239 + * @param <U> type of function input
240 + * @param <V> type of function output
239 */ 241 */
240 public static <U, V> Function<U, V> retryable(Function<U, V> base, 242 public static <U, V> Function<U, V> retryable(Function<U, V> base,
241 Class<? extends Throwable> exceptionClass, 243 Class<? extends Throwable> exceptionClass,
...@@ -252,6 +254,7 @@ public abstract class Tools { ...@@ -252,6 +254,7 @@ public abstract class Tools {
252 * @param maxDelayBetweenRetries max delay between successive retries. The actual delay is randomly picked from 254 * @param maxDelayBetweenRetries max delay between successive retries. The actual delay is randomly picked from
253 * the interval (0, maxDelayBetweenRetries] 255 * the interval (0, maxDelayBetweenRetries]
254 * @return supplier 256 * @return supplier
257 + * @param <V> type of supplied result
255 */ 258 */
256 public static <V> Supplier<V> retryable(Supplier<V> base, 259 public static <V> Supplier<V> retryable(Supplier<V> base,
257 Class<? extends Throwable> exceptionClass, 260 Class<? extends Throwable> exceptionClass,
......
...@@ -17,6 +17,10 @@ package org.onlab.util; ...@@ -17,6 +17,10 @@ package org.onlab.util;
17 17
18 /** 18 /**
19 * A consumer that accepts three arguments. 19 * A consumer that accepts three arguments.
20 + *
21 + * @param <U> type of first argument
22 + * @param <V> type of second argument
23 + * @param <W> type of third argument
20 */ 24 */
21 public interface TriConsumer<U, V, W> { 25 public interface TriConsumer<U, V, W> {
22 26
......
...@@ -107,6 +107,8 @@ public class ApiDocResource extends AbstractInjectionResource { ...@@ -107,6 +107,8 @@ public class ApiDocResource extends AbstractInjectionResource {
107 * Get Swagger UI main index page. 107 * Get Swagger UI main index page.
108 * 108 *
109 * @return 200 OK 109 * @return 200 OK
110 + * @throws IOException if unable to get index resource
111 + * @throws URISyntaxException if unable to create redirect URI
110 */ 112 */
111 @GET 113 @GET
112 @Path("/") 114 @Path("/")
...@@ -119,6 +121,7 @@ public class ApiDocResource extends AbstractInjectionResource { ...@@ -119,6 +121,7 @@ public class ApiDocResource extends AbstractInjectionResource {
119 * Get Swagger UI main index page. 121 * Get Swagger UI main index page.
120 * 122 *
121 * @return 200 OK 123 * @return 200 OK
124 + * @throws IOException if unable to get index resource
122 */ 125 */
123 @GET 126 @GET
124 @Path("index.html") 127 @Path("index.html")
...@@ -155,7 +158,9 @@ public class ApiDocResource extends AbstractInjectionResource { ...@@ -155,7 +158,9 @@ public class ApiDocResource extends AbstractInjectionResource {
155 /** 158 /**
156 * Get Swagger UI resource. 159 * Get Swagger UI resource.
157 * 160 *
161 + * @param resource path of the resource
158 * @return 200 OK 162 * @return 200 OK
163 + * @throws IOException if unable to get named resource
159 */ 164 */
160 @GET 165 @GET
161 @Path("{resource: .*}") 166 @Path("{resource: .*}")
......
...@@ -77,6 +77,7 @@ public class ClusterWebResource extends AbstractWebResource { ...@@ -77,6 +77,7 @@ public class ClusterWebResource extends AbstractWebResource {
77 * 77 *
78 * @param config cluster definition 78 * @param config cluster definition
79 * @return 200 OK 79 * @return 200 OK
80 + * @throws IOException to signify bad request
80 */ 81 */
81 @POST 82 @POST
82 @Path("configuration") 83 @Path("configuration")
......
...@@ -82,7 +82,9 @@ public class ComponentConfigWebResource extends AbstractWebResource { ...@@ -82,7 +82,9 @@ public class ComponentConfigWebResource extends AbstractWebResource {
82 * Sets only the properties present in the JSON request. 82 * Sets only the properties present in the JSON request.
83 * 83 *
84 * @param component component name 84 * @param component component name
85 + * @param request JSON configuration
85 * @return 200 OK 86 * @return 200 OK
87 + * @throws IOException to signify bad request
86 */ 88 */
87 @POST 89 @POST
88 @Path("{component}") 90 @Path("{component}")
...@@ -100,7 +102,9 @@ public class ComponentConfigWebResource extends AbstractWebResource { ...@@ -100,7 +102,9 @@ public class ComponentConfigWebResource extends AbstractWebResource {
100 * Clears only the properties present in the JSON request. 102 * Clears only the properties present in the JSON request.
101 * 103 *
102 * @param component component name 104 * @param component component name
105 + * @param request JSON configuration
103 * @return 200 OK 106 * @return 200 OK
107 + * @throws IOException to signify bad request
104 */ 108 */
105 @DELETE 109 @DELETE
106 @Path("{component}") 110 @Path("{component}")
......