Fixing javadocs.
Change-Id: I9e6b3d7eb08d17d4ad450277a1279f6aaefd4640
Showing
10 changed files
with
89 additions
and
8 deletions
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * BGP routing application components. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.bgprouter; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -53,13 +53,14 @@ public class LocalIpPrefixEntry { | ... | @@ -53,13 +53,14 @@ public class LocalIpPrefixEntry { |
| 53 | /** | 53 | /** |
| 54 | * Creates a new IP prefix entry. | 54 | * Creates a new IP prefix entry. |
| 55 | * | 55 | * |
| 56 | - * @param ipPrefix an IP prefix as a String | 56 | + * @param ipPrefix an IP prefix as a String |
| 57 | - * @param type an IP prefix type as an IpPrefixType | 57 | + * @param type an IP prefix type as an IpPrefixType |
| 58 | + * @param gatewayIpAddress IP of the gateway | ||
| 58 | */ | 59 | */ |
| 59 | public LocalIpPrefixEntry(@JsonProperty("ipPrefix") String ipPrefix, | 60 | public LocalIpPrefixEntry(@JsonProperty("ipPrefix") String ipPrefix, |
| 60 | @JsonProperty("type") IpPrefixType type, | 61 | @JsonProperty("type") IpPrefixType type, |
| 61 | @JsonProperty("gatewayIp") IpAddress | 62 | @JsonProperty("gatewayIp") IpAddress |
| 62 | - gatewayIpAddress) { | 63 | + gatewayIpAddress) { |
| 63 | this.ipPrefix = IpPrefix.valueOf(ipPrefix); | 64 | this.ipPrefix = IpPrefix.valueOf(ipPrefix); |
| 64 | this.type = type; | 65 | this.type = type; |
| 65 | this.gatewayIpAddress = gatewayIpAddress; | 66 | this.gatewayIpAddress = gatewayIpAddress; | ... | ... |
| ... | @@ -58,7 +58,7 @@ public class IcmpHandler { | ... | @@ -58,7 +58,7 @@ public class IcmpHandler { |
| 58 | * If it is an ICMP packet to unknown host in a subnet, then sends an ARP request | 58 | * If it is an ICMP packet to unknown host in a subnet, then sends an ARP request |
| 59 | * to the subnet. | 59 | * to the subnet. |
| 60 | * | 60 | * |
| 61 | - * @param pkt | 61 | + * @param pkt inbound packet |
| 62 | */ | 62 | */ |
| 63 | public void processPacketIn(InboundPacket pkt) { | 63 | public void processPacketIn(InboundPacket pkt) { |
| 64 | 64 | ... | ... |
| ... | @@ -53,7 +53,7 @@ public class RoutingRulePopulator { | ... | @@ -53,7 +53,7 @@ public class RoutingRulePopulator { |
| 53 | /** | 53 | /** |
| 54 | * Creates a RoutingRulePopulator object. | 54 | * Creates a RoutingRulePopulator object. |
| 55 | * | 55 | * |
| 56 | - * @param srManager | 56 | + * @param srManager segment routing manager reference |
| 57 | */ | 57 | */ |
| 58 | public RoutingRulePopulator(SegmentRoutingManager srManager) { | 58 | public RoutingRulePopulator(SegmentRoutingManager srManager) { |
| 59 | this.srManager = srManager; | 59 | this.srManager = srManager; | ... | ... |
apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/config/package-info.java
0 → 100644
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Segment routing network configuration mechanism. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.segmentrouting.config; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
apps/segmentrouting/src/main/java/org/onosproject/segmentrouting/grouphandler/package-info.java
0 → 100644
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Segment routing group handling. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.segmentrouting.grouphandler; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| 1 | +/* | ||
| 2 | + * Copyright 2015 Open Networking Laboratory | ||
| 3 | + * | ||
| 4 | + * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| 5 | + * you may not use this file except in compliance with the License. | ||
| 6 | + * You may obtain a copy of the License at | ||
| 7 | + * | ||
| 8 | + * http://www.apache.org/licenses/LICENSE-2.0 | ||
| 9 | + * | ||
| 10 | + * Unless required by applicable law or agreed to in writing, software | ||
| 11 | + * distributed under the License is distributed on an "AS IS" BASIS, | ||
| 12 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| 13 | + * See the License for the specific language governing permissions and | ||
| 14 | + * limitations under the License. | ||
| 15 | + */ | ||
| 16 | + | ||
| 17 | +/** | ||
| 18 | + * Segment routing application components. | ||
| 19 | + */ | ||
| 20 | +package org.onosproject.segmentrouting; | ||
| ... | \ No newline at end of file | ... | \ No newline at end of file |
| ... | @@ -248,7 +248,7 @@ public final class DefaultPortStatistics implements PortStatistics { | ... | @@ -248,7 +248,7 @@ public final class DefaultPortStatistics implements PortStatistics { |
| 248 | /** | 248 | /** |
| 249 | * Sets the number of packets dropped by TX. | 249 | * Sets the number of packets dropped by TX. |
| 250 | * | 250 | * |
| 251 | - * @param packets | 251 | + * @param packets number of packets |
| 252 | * @return builder object | 252 | * @return builder object |
| 253 | */ | 253 | */ |
| 254 | public Builder setPacketsTxDropped(long packets) { | 254 | public Builder setPacketsTxDropped(long packets) { | ... | ... |
| ... | @@ -103,7 +103,7 @@ | ... | @@ -103,7 +103,7 @@ |
| 103 | <group> | 103 | <group> |
| 104 | <title>Sample Applications</title> | 104 | <title>Sample Applications</title> |
| 105 | <packages> | 105 | <packages> |
| 106 | - org.onosproject.tvue:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.foo:org.onosproject.calendar:org.onosproject.optical:org.onosproject.optical.*:org.onosproject.sdnip:org.onosproject.sdnip.*:org.onosproject.config:org.onosproject.routing:org.onosproject.routing*:org.onosproject.bgprouter:org.onosproject.intentperf | 106 | + org.onosproject.tvue:org.onosproject.fwd:org.onosproject.ifwd:org.onosproject.mobility:org.onosproject.proxyarp:org.onosproject.foo:org.onosproject.calendar:org.onosproject.optical:org.onosproject.optical.*:org.onosproject.sdnip:org.onosproject.sdnip.*:org.onosproject.config:org.onosproject.routing:org.onosproject.routing*:org.onosproject.bgprouter:org.onosproject.intentperf:org.onosproject.segmentrouting:org.onosproject.segmentrouting.*:org.onosproject.reactive.routing* |
| 107 | </packages> | 107 | </packages> |
| 108 | </group> | 108 | </group> |
| 109 | <group> | 109 | <group> | ... | ... |
| ... | @@ -88,7 +88,7 @@ public class MPLS extends BasePacket { | ... | @@ -88,7 +88,7 @@ public class MPLS extends BasePacket { |
| 88 | /** | 88 | /** |
| 89 | * Sets the MPLS label. | 89 | * Sets the MPLS label. |
| 90 | * | 90 | * |
| 91 | - * @param label | 91 | + * @param label MPLS label |
| 92 | */ | 92 | */ |
| 93 | public void setLabel(int label) { | 93 | public void setLabel(int label) { |
| 94 | this.label = label; | 94 | this.label = label; | ... | ... |
-
Please register or login to post a comment