Committed by
Gerrit Code Review
Javadoc improvement
Change-Id: I4f767af36101c32493a77570a9729f4e8c300136
Showing
11 changed files
with
18 additions
and
10 deletions
... | @@ -45,7 +45,7 @@ import java.util.concurrent.CountDownLatch; | ... | @@ -45,7 +45,7 @@ import java.util.concurrent.CountDownLatch; |
45 | import java.util.concurrent.TimeUnit; | 45 | import java.util.concurrent.TimeUnit; |
46 | 46 | ||
47 | /** | 47 | /** |
48 | - * Installs many many flows. | 48 | + * Installs bulk flows. |
49 | */ | 49 | */ |
50 | @Command(scope = "onos", name = "add-flows", | 50 | @Command(scope = "onos", name = "add-flows", |
51 | description = "Installs a number of test flow rules - for testing only") | 51 | description = "Installs a number of test flow rules - for testing only") | ... | ... |
... | @@ -19,6 +19,9 @@ import org.onosproject.net.intent.MplsIntent; | ... | @@ -19,6 +19,9 @@ import org.onosproject.net.intent.MplsIntent; |
19 | import static org.onosproject.net.DeviceId.deviceId; | 19 | import static org.onosproject.net.DeviceId.deviceId; |
20 | import static org.onosproject.net.PortNumber.portNumber; | 20 | import static org.onosproject.net.PortNumber.portNumber; |
21 | 21 | ||
22 | +/** | ||
23 | + * Installs MPLS intents. | ||
24 | + */ | ||
22 | @Command(scope = "onos", name = "add-mpls-intent", description = "Installs mpls connectivity intent") | 25 | @Command(scope = "onos", name = "add-mpls-intent", description = "Installs mpls connectivity intent") |
23 | public class AddMplsIntent extends ConnectivityIntentCommand { | 26 | public class AddMplsIntent extends ConnectivityIntentCommand { |
24 | 27 | ... | ... |
... | @@ -35,10 +35,10 @@ import static org.onosproject.net.DeviceId.deviceId; | ... | @@ -35,10 +35,10 @@ import static org.onosproject.net.DeviceId.deviceId; |
35 | import static org.onosproject.net.PortNumber.portNumber; | 35 | import static org.onosproject.net.PortNumber.portNumber; |
36 | 36 | ||
37 | /** | 37 | /** |
38 | - * Installs point-to-point connectivity intents. | 38 | + * Installs connectivity intent between multiple ingress devices and a single egress device. |
39 | */ | 39 | */ |
40 | @Command(scope = "onos", name = "add-multi-to-single-intent", | 40 | @Command(scope = "onos", name = "add-multi-to-single-intent", |
41 | - description = "Installs point-to-point connectivity intent") | 41 | + description = "Installs connectivity intent between multiple ingress devices and a single egress device") |
42 | public class AddMultiPointToSinglePointIntentCommand extends ConnectivityIntentCommand { | 42 | public class AddMultiPointToSinglePointIntentCommand extends ConnectivityIntentCommand { |
43 | 43 | ||
44 | @Argument(index = 0, name = "ingressDevices egressDevice", | 44 | @Argument(index = 0, name = "ingressDevices egressDevice", | ... | ... |
... | @@ -34,7 +34,9 @@ import org.onosproject.net.intent.SinglePointToMultiPointIntent; | ... | @@ -34,7 +34,9 @@ import org.onosproject.net.intent.SinglePointToMultiPointIntent; |
34 | import static org.onosproject.net.DeviceId.deviceId; | 34 | import static org.onosproject.net.DeviceId.deviceId; |
35 | import static org.onosproject.net.PortNumber.portNumber; | 35 | import static org.onosproject.net.PortNumber.portNumber; |
36 | 36 | ||
37 | - | 37 | +/** |
38 | + * Installs connectivity intent between a single ingress device and multiple egress devices. | ||
39 | + */ | ||
38 | @Command(scope = "onos", name = "add-single-to-multi-intent", | 40 | @Command(scope = "onos", name = "add-single-to-multi-intent", |
39 | description = "Installs connectivity intent between a single ingress device and multiple egress devices") | 41 | description = "Installs connectivity intent between a single ingress device and multiple egress devices") |
40 | public class AddSinglePointToMultiPointIntentCommand extends ConnectivityIntentCommand { | 42 | public class AddSinglePointToMultiPointIntentCommand extends ConnectivityIntentCommand { | ... | ... |
... | @@ -38,7 +38,7 @@ public class CountersListCommand extends AbstractShellCommand { | ... | @@ -38,7 +38,7 @@ public class CountersListCommand extends AbstractShellCommand { |
38 | /** | 38 | /** |
39 | * Displays counters as text. | 39 | * Displays counters as text. |
40 | * | 40 | * |
41 | - * @param mapInfo map descriptions | 41 | + * @param counters counter info |
42 | */ | 42 | */ |
43 | private void displayCounters(Map<String, Long> counters) { | 43 | private void displayCounters(Map<String, Long> counters) { |
44 | counters.forEach((name, value) -> print(FMT, name, value)); | 44 | counters.forEach((name, value) -> print(FMT, name, value)); | ... | ... |
... | @@ -23,7 +23,7 @@ import org.apache.karaf.shell.console.completer.StringsCompleter; | ... | @@ -23,7 +23,7 @@ import org.apache.karaf.shell.console.completer.StringsCompleter; |
23 | import org.onosproject.net.flow.FlowEntry.FlowEntryState; | 23 | import org.onosproject.net.flow.FlowEntry.FlowEntryState; |
24 | 24 | ||
25 | /** | 25 | /** |
26 | - * Device ID completer. | 26 | + * Flow rule status completer. |
27 | */ | 27 | */ |
28 | public class FlowRuleStatusCompleter implements Completer { | 28 | public class FlowRuleStatusCompleter implements Completer { |
29 | @Override | 29 | @Override | ... | ... |
... | @@ -25,6 +25,9 @@ import org.onosproject.cli.AbstractShellCommand; | ... | @@ -25,6 +25,9 @@ import org.onosproject.cli.AbstractShellCommand; |
25 | import org.onosproject.net.Host; | 25 | import org.onosproject.net.Host; |
26 | import org.onosproject.net.host.HostService; | 26 | import org.onosproject.net.host.HostService; |
27 | 27 | ||
28 | +/** | ||
29 | + * Host ID completer. | ||
30 | + */ | ||
28 | public class HostIdCompleter implements Completer { | 31 | public class HostIdCompleter implements Completer { |
29 | 32 | ||
30 | @Override | 33 | @Override | ... | ... |
... | @@ -47,7 +47,7 @@ import static org.onosproject.net.DeviceId.deviceId; | ... | @@ -47,7 +47,7 @@ import static org.onosproject.net.DeviceId.deviceId; |
47 | import static org.onosproject.net.PortNumber.portNumber; | 47 | import static org.onosproject.net.PortNumber.portNumber; |
48 | 48 | ||
49 | /** | 49 | /** |
50 | - * Installs point-to-point connectivity intents. | 50 | + * Installs bulk point-to-point connectivity intents between given ingress/egress devices. |
51 | */ | 51 | */ |
52 | @Command(scope = "onos", name = "push-test-intents", | 52 | @Command(scope = "onos", name = "push-test-intents", |
53 | description = "Installs random intents to test throughput") | 53 | description = "Installs random intents to test throughput") | ... | ... |
... | @@ -31,7 +31,7 @@ import static org.onosproject.net.DeviceId.deviceId; | ... | @@ -31,7 +31,7 @@ import static org.onosproject.net.DeviceId.deviceId; |
31 | import static org.onosproject.net.PortNumber.portNumber; | 31 | import static org.onosproject.net.PortNumber.portNumber; |
32 | 32 | ||
33 | /** | 33 | /** |
34 | - * Link end-point completer. | 34 | + * Link destination end-point completer. |
35 | */ | 35 | */ |
36 | public class LinkDstCompleter extends AbstractCompleter { | 36 | public class LinkDstCompleter extends AbstractCompleter { |
37 | @Override | 37 | @Override | ... | ... |
... | @@ -24,7 +24,7 @@ import java.util.List; | ... | @@ -24,7 +24,7 @@ import java.util.List; |
24 | import java.util.SortedSet; | 24 | import java.util.SortedSet; |
25 | 25 | ||
26 | /** | 26 | /** |
27 | - * Link end-point completer. | 27 | + * Link source end-point completer. |
28 | */ | 28 | */ |
29 | public class LinkSrcCompleter extends AbstractCompleter { | 29 | public class LinkSrcCompleter extends AbstractCompleter { |
30 | @Override | 30 | @Override | ... | ... |
... | @@ -33,7 +33,7 @@ import org.onosproject.net.intent.IntentService; | ... | @@ -33,7 +33,7 @@ import org.onosproject.net.intent.IntentService; |
33 | import com.google.common.collect.Lists; | 33 | import com.google.common.collect.Lists; |
34 | 34 | ||
35 | /** | 35 | /** |
36 | - * Installs point-to-point connectivity intents. | 36 | + * Installs bulk point-to-point connectivity intents between random ingress/egress devices. |
37 | */ | 37 | */ |
38 | @Command(scope = "onos", name = "push-random-intents", | 38 | @Command(scope = "onos", name = "push-random-intents", |
39 | description = "Installs random intents to test throughput") | 39 | description = "Installs random intents to test throughput") | ... | ... |
-
Please register or login to post a comment