Jian Li

Fix all javadoc warnings

Change-Id: I26ba78195fd8245eeb25c29ba27cc4b11b2eb791
Showing 11 changed files with 26 additions and 13 deletions
1 /* 1 /*
2 - * Copyright 2015 Open Networking Laboratory 2 + * Copyright 2015-2016 Open Networking Laboratory
3 * 3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License. 5 * you may not use this file except in compliance with the License.
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
15 */ 15 */
16 16
17 /** 17 /**
18 - * OpenStack switch interface. 18 + * OpenStack switch API.
19 */ 19 */
20 package org.onosproject.openstackswitching; 20 package org.onosproject.openstackswitching;
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
13 * See the License for the specific language governing permissions and 13 * See the License for the specific language governing permissions and
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 -package org.onosproject.openstackswitching; 16 +package org.onosproject.openstackswitching.impl;
17 17
18 import org.onlab.packet.ARP; 18 import org.onlab.packet.ARP;
19 import org.onlab.packet.Ethernet; 19 import org.onlab.packet.Ethernet;
...@@ -27,6 +27,7 @@ import org.onosproject.net.host.HostService; ...@@ -27,6 +27,7 @@ import org.onosproject.net.host.HostService;
27 import org.onosproject.net.packet.DefaultOutboundPacket; 27 import org.onosproject.net.packet.DefaultOutboundPacket;
28 import org.onosproject.net.packet.InboundPacket; 28 import org.onosproject.net.packet.InboundPacket;
29 import org.onosproject.net.packet.PacketService; 29 import org.onosproject.net.packet.PacketService;
30 +import org.onosproject.openstackswitching.OpenstackPort;
30 import org.slf4j.Logger; 31 import org.slf4j.Logger;
31 import org.slf4j.LoggerFactory; 32 import org.slf4j.LoggerFactory;
32 import java.nio.ByteBuffer; 33 import java.nio.ByteBuffer;
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
13 * See the License for the specific language governing permissions and 13 * See the License for the specific language governing permissions and
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 -package org.onosproject.openstackswitching; 16 +package org.onosproject.openstackswitching.impl;
17 17
18 import org.onlab.packet.Ip4Address; 18 import org.onlab.packet.Ip4Address;
19 import org.onosproject.net.DeviceId; 19 import org.onosproject.net.DeviceId;
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
13 * See the License for the specific language governing permissions and 13 * See the License for the specific language governing permissions and
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 -package org.onosproject.openstackswitching; 16 +package org.onosproject.openstackswitching.impl;
17 17
18 import com.fasterxml.jackson.databind.ObjectMapper; 18 import com.fasterxml.jackson.databind.ObjectMapper;
19 import com.fasterxml.jackson.databind.node.ArrayNode; 19 import com.fasterxml.jackson.databind.node.ArrayNode;
...@@ -21,6 +21,9 @@ import com.fasterxml.jackson.databind.node.ObjectNode; ...@@ -21,6 +21,9 @@ import com.fasterxml.jackson.databind.node.ObjectNode;
21 import com.google.common.collect.Lists; 21 import com.google.common.collect.Lists;
22 import com.sun.jersey.api.client.Client; 22 import com.sun.jersey.api.client.Client;
23 import com.sun.jersey.api.client.WebResource; 23 import com.sun.jersey.api.client.WebResource;
24 +import org.onosproject.openstackswitching.OpenstackNetwork;
25 +import org.onosproject.openstackswitching.OpenstackPort;
26 +import org.onosproject.openstackswitching.OpenstackSubnet;
24 import org.onosproject.openstackswitching.web.OpenstackNetworkCodec; 27 import org.onosproject.openstackswitching.web.OpenstackNetworkCodec;
25 import org.onosproject.openstackswitching.web.OpenstackPortCodec; 28 import org.onosproject.openstackswitching.web.OpenstackPortCodec;
26 import org.onosproject.openstackswitching.web.OpenstackSubnetCodec; 29 import org.onosproject.openstackswitching.web.OpenstackSubnetCodec;
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
13 * See the License for the specific language governing permissions and 13 * See the License for the specific language governing permissions and
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 -package org.onosproject.openstackswitching; 16 +package org.onosproject.openstackswitching.impl;
17 17
18 import org.onosproject.core.ApplicationId; 18 import org.onosproject.core.ApplicationId;
19 import org.onosproject.net.config.Config; 19 import org.onosproject.net.config.Config;
......
...@@ -13,7 +13,7 @@ ...@@ -13,7 +13,7 @@
13 * See the License for the specific language governing permissions and 13 * See the License for the specific language governing permissions and
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 -package org.onosproject.openstackswitching; 16 +package org.onosproject.openstackswitching.impl;
17 17
18 import com.google.common.collect.ImmutableSet; 18 import com.google.common.collect.ImmutableSet;
19 import com.google.common.collect.Lists; 19 import com.google.common.collect.Lists;
...@@ -50,6 +50,10 @@ import org.onosproject.net.packet.InboundPacket; ...@@ -50,6 +50,10 @@ import org.onosproject.net.packet.InboundPacket;
50 import org.onosproject.net.packet.PacketContext; 50 import org.onosproject.net.packet.PacketContext;
51 import org.onosproject.net.packet.PacketProcessor; 51 import org.onosproject.net.packet.PacketProcessor;
52 import org.onosproject.net.packet.PacketService; 52 import org.onosproject.net.packet.PacketService;
53 +import org.onosproject.openstackswitching.OpenstackNetwork;
54 +import org.onosproject.openstackswitching.OpenstackPort;
55 +import org.onosproject.openstackswitching.OpenstackSubnet;
56 +import org.onosproject.openstackswitching.OpenstackSwitchingService;
53 import org.slf4j.Logger; 57 import org.slf4j.Logger;
54 import org.slf4j.LoggerFactory; 58 import org.slf4j.LoggerFactory;
55 import java.util.List; 59 import java.util.List;
......
...@@ -14,7 +14,7 @@ ...@@ -14,7 +14,7 @@
14 * limitations under the License. 14 * limitations under the License.
15 */ 15 */
16 16
17 -package org.onosproject.openstackswitching; 17 +package org.onosproject.openstackswitching.impl;
18 18
19 import org.onlab.packet.Ethernet; 19 import org.onlab.packet.Ethernet;
20 import org.onlab.packet.Ip4Address; 20 import org.onlab.packet.Ip4Address;
...@@ -40,6 +40,8 @@ import org.onosproject.net.flow.instructions.ExtensionTreatmentType; ...@@ -40,6 +40,8 @@ import org.onosproject.net.flow.instructions.ExtensionTreatmentType;
40 import org.onosproject.net.flowobjective.DefaultForwardingObjective; 40 import org.onosproject.net.flowobjective.DefaultForwardingObjective;
41 import org.onosproject.net.flowobjective.FlowObjectiveService; 41 import org.onosproject.net.flowobjective.FlowObjectiveService;
42 import org.onosproject.net.flowobjective.ForwardingObjective; 42 import org.onosproject.net.flowobjective.ForwardingObjective;
43 +import org.onosproject.openstackswitching.OpenstackNetwork;
44 +import org.onosproject.openstackswitching.OpenstackPort;
43 import org.slf4j.Logger; 45 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory; 46 import org.slf4j.LoggerFactory;
45 47
......
1 /* 1 /*
2 - * Copyright 2015 Open Networking Laboratory 2 + * Copyright 2015-2016 Open Networking Laboratory
3 * 3 *
4 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License. 5 * you may not use this file except in compliance with the License.
...@@ -15,6 +15,6 @@ ...@@ -15,6 +15,6 @@
15 */ 15 */
16 16
17 /** 17 /**
18 - * OpenStack switch interface. 18 + * OpenStack switch implementation.
19 */ 19 */
20 -package org.onosproject.openstackswitching; 20 +package org.onosproject.openstackswitching.impl;
......
...@@ -30,7 +30,6 @@ import com.google.common.collect.Lists; ...@@ -30,7 +30,6 @@ import com.google.common.collect.Lists;
30 * <p> 30 * <p>
31 * Usage Example: 31 * Usage Example:
32 * <pre> 32 * <pre>
33 - * <code>
34 private ListenerTracker listeners; 33 private ListenerTracker listeners;
35 34
36 {@code @Activate} 35 {@code @Activate}
...@@ -47,7 +46,6 @@ import com.google.common.collect.Lists; ...@@ -47,7 +46,6 @@ import com.google.common.collect.Lists;
47 protected void deactivate() { 46 protected void deactivate() {
48 listeners.removeListeners(); 47 listeners.removeListeners();
49 } 48 }
50 - * </code>
51 * </pre> 49 * </pre>
52 */ 50 */
53 @Beta 51 @Beta
...@@ -60,6 +58,8 @@ public class ListenerTracker { ...@@ -60,6 +58,8 @@ public class ListenerTracker {
60 /** 58 /**
61 * Adds {@link EventListener} to specified {@link ListenerService}. 59 * Adds {@link EventListener} to specified {@link ListenerService}.
62 * 60 *
61 + * @param <E> event
62 + * @param <L> listener
63 * @param service {@link ListenerService} 63 * @param service {@link ListenerService}
64 * @param listener {@link EventListener} 64 * @param listener {@link EventListener}
65 * @return self 65 * @return self
......
...@@ -31,6 +31,7 @@ public final class GuavaCollectors { ...@@ -31,6 +31,7 @@ public final class GuavaCollectors {
31 * Returns a {@code Collector} that accumulates the input elements into a 31 * Returns a {@code Collector} that accumulates the input elements into a
32 * new ImmutableSet. 32 * new ImmutableSet.
33 * 33 *
34 + * @param <T> type
34 * @return a {@code Collector} which collects all the input elements into a 35 * @return a {@code Collector} which collects all the input elements into a
35 * {@code ImmutableSet} 36 * {@code ImmutableSet}
36 */ 37 */
...@@ -46,6 +47,7 @@ public final class GuavaCollectors { ...@@ -46,6 +47,7 @@ public final class GuavaCollectors {
46 * Returns a {@code Collector} that accumulates the input elements into a 47 * Returns a {@code Collector} that accumulates the input elements into a
47 * new ImmutableList. 48 * new ImmutableList.
48 * 49 *
50 + * @param <T> type
49 * @return a {@code Collector} which collects all the input elements into a 51 * @return a {@code Collector} which collects all the input elements into a
50 * {@code ImmutableList}, in encounter order 52 * {@code ImmutableList}, in encounter order
51 */ 53 */
......
...@@ -40,6 +40,7 @@ public class UnmodifiableDeque<E> implements Deque<E> { ...@@ -40,6 +40,7 @@ public class UnmodifiableDeque<E> implements Deque<E> {
40 /** 40 /**
41 * Returns an unmodifiable view of the specified Deque. 41 * Returns an unmodifiable view of the specified Deque.
42 * 42 *
43 + * @param <T> type
43 * @param deque underlying {@link Deque} to use. 44 * @param deque underlying {@link Deque} to use.
44 * @return unmodifiable view of {@code deque} 45 * @return unmodifiable view of {@code deque}
45 */ 46 */
......