Fix Javadoc warnings
Change-Id: I857d8bd7d9fc0862f3c0097d3e65cbedfb997b0f
Showing
3 changed files
with
10 additions
and
0 deletions
... | @@ -44,6 +44,7 @@ public class Interface { | ... | @@ -44,6 +44,7 @@ public class Interface { |
44 | * @param connectPoint the connect point this interface is mapped to | 44 | * @param connectPoint the connect point this interface is mapped to |
45 | * @param ipAddresses the IP addresses for the interface | 45 | * @param ipAddresses the IP addresses for the interface |
46 | * @param macAddress the MAC address of the interface | 46 | * @param macAddress the MAC address of the interface |
47 | + * @param vlan VLAN identifier | ||
47 | */ | 48 | */ |
48 | public Interface(ConnectPoint connectPoint, | 49 | public Interface(ConnectPoint connectPoint, |
49 | Set<InterfaceIpAddress> ipAddresses, | 50 | Set<InterfaceIpAddress> ipAddresses, | ... | ... |
... | @@ -144,6 +144,8 @@ public interface OpenFlowSwitch { | ... | @@ -144,6 +144,8 @@ public interface OpenFlowSwitch { |
144 | 144 | ||
145 | /** | 145 | /** |
146 | * Identifies the channel used to communicate with the switch. | 146 | * Identifies the channel used to communicate with the switch. |
147 | + * | ||
148 | + * @return string representation of the connection to the device | ||
147 | */ | 149 | */ |
148 | public String channelId(); | 150 | public String channelId(); |
149 | 151 | ... | ... |
... | @@ -80,6 +80,7 @@ public class TopologyWebResource extends AbstractWebResource { | ... | @@ -80,6 +80,7 @@ public class TopologyWebResource extends AbstractWebResource { |
80 | /** | 80 | /** |
81 | * Gets details for a topology cluster for a REST GET operation. | 81 | * Gets details for a topology cluster for a REST GET operation. |
82 | * | 82 | * |
83 | + * @param clusterId id of the cluster to query | ||
83 | * @return topology cluster details | 84 | * @return topology cluster details |
84 | */ | 85 | */ |
85 | @GET | 86 | @GET |
... | @@ -101,6 +102,7 @@ public class TopologyWebResource extends AbstractWebResource { | ... | @@ -101,6 +102,7 @@ public class TopologyWebResource extends AbstractWebResource { |
101 | /** | 102 | /** |
102 | * Gets devices for a topology cluster for a REST GET operation. | 103 | * Gets devices for a topology cluster for a REST GET operation. |
103 | * | 104 | * |
105 | + * @param clusterId id of the cluster to query | ||
104 | * @return topology cluster devices | 106 | * @return topology cluster devices |
105 | */ | 107 | */ |
106 | @GET | 108 | @GET |
... | @@ -131,6 +133,7 @@ public class TopologyWebResource extends AbstractWebResource { | ... | @@ -131,6 +133,7 @@ public class TopologyWebResource extends AbstractWebResource { |
131 | /** | 133 | /** |
132 | * Gets links for a topology cluster for a REST GET operation. | 134 | * Gets links for a topology cluster for a REST GET operation. |
133 | * | 135 | * |
136 | + * @param clusterId id of the cluster to query | ||
134 | * @return topology cluster links | 137 | * @return topology cluster links |
135 | */ | 138 | */ |
136 | @GET | 139 | @GET |
... | @@ -181,6 +184,8 @@ public class TopologyWebResource extends AbstractWebResource { | ... | @@ -181,6 +184,8 @@ public class TopologyWebResource extends AbstractWebResource { |
181 | /** | 184 | /** |
182 | * Gets the broadcast flag of a connect point for a REST GET operation. | 185 | * Gets the broadcast flag of a connect point for a REST GET operation. |
183 | * | 186 | * |
187 | + * @param connectPointString string representation of the connect point to query. | ||
188 | + * Format is deviceid:portnumber | ||
184 | * @return JSON representation of true if the connect point is broadcast, | 189 | * @return JSON representation of true if the connect point is broadcast, |
185 | * false otherwise | 190 | * false otherwise |
186 | */ | 191 | */ |
... | @@ -202,6 +207,8 @@ public class TopologyWebResource extends AbstractWebResource { | ... | @@ -202,6 +207,8 @@ public class TopologyWebResource extends AbstractWebResource { |
202 | /** | 207 | /** |
203 | * Gets the infrastructure flag of a connect point for a REST GET operation. | 208 | * Gets the infrastructure flag of a connect point for a REST GET operation. |
204 | * | 209 | * |
210 | + * @param connectPointString string representation of the connect point to query. | ||
211 | + * Format is deviceid:portnumber | ||
205 | * @return JSON representation of true if the connect point is broadcast, | 212 | * @return JSON representation of true if the connect point is broadcast, |
206 | * false otherwise | 213 | * false otherwise |
207 | */ | 214 | */ | ... | ... |
-
Please register or login to post a comment