Charles M.C. Chan
Committed by Gerrit Code Review

Javadoc improvement

Change-Id: I4f767af36101c32493a77570a9729f4e8c300136
......@@ -45,7 +45,7 @@ import java.util.concurrent.CountDownLatch;
import java.util.concurrent.TimeUnit;
/**
* Installs many many flows.
* Installs bulk flows.
*/
@Command(scope = "onos", name = "add-flows",
description = "Installs a number of test flow rules - for testing only")
......
......@@ -19,6 +19,9 @@ import org.onosproject.net.intent.MplsIntent;
import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.PortNumber.portNumber;
/**
* Installs MPLS intents.
*/
@Command(scope = "onos", name = "add-mpls-intent", description = "Installs mpls connectivity intent")
public class AddMplsIntent extends ConnectivityIntentCommand {
......
......@@ -35,10 +35,10 @@ import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.PortNumber.portNumber;
/**
* Installs point-to-point connectivity intents.
* Installs connectivity intent between multiple ingress devices and a single egress device.
*/
@Command(scope = "onos", name = "add-multi-to-single-intent",
description = "Installs point-to-point connectivity intent")
description = "Installs connectivity intent between multiple ingress devices and a single egress device")
public class AddMultiPointToSinglePointIntentCommand extends ConnectivityIntentCommand {
@Argument(index = 0, name = "ingressDevices egressDevice",
......
......@@ -34,7 +34,9 @@ import org.onosproject.net.intent.SinglePointToMultiPointIntent;
import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.PortNumber.portNumber;
/**
* Installs connectivity intent between a single ingress device and multiple egress devices.
*/
@Command(scope = "onos", name = "add-single-to-multi-intent",
description = "Installs connectivity intent between a single ingress device and multiple egress devices")
public class AddSinglePointToMultiPointIntentCommand extends ConnectivityIntentCommand {
......
......@@ -38,7 +38,7 @@ public class CountersListCommand extends AbstractShellCommand {
/**
* Displays counters as text.
*
* @param mapInfo map descriptions
* @param counters counter info
*/
private void displayCounters(Map<String, Long> counters) {
counters.forEach((name, value) -> print(FMT, name, value));
......
......@@ -23,7 +23,7 @@ import org.apache.karaf.shell.console.completer.StringsCompleter;
import org.onosproject.net.flow.FlowEntry.FlowEntryState;
/**
* Device ID completer.
* Flow rule status completer.
*/
public class FlowRuleStatusCompleter implements Completer {
@Override
......
......@@ -25,6 +25,9 @@ import org.onosproject.cli.AbstractShellCommand;
import org.onosproject.net.Host;
import org.onosproject.net.host.HostService;
/**
* Host ID completer.
*/
public class HostIdCompleter implements Completer {
@Override
......
......@@ -47,7 +47,7 @@ import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.PortNumber.portNumber;
/**
* Installs point-to-point connectivity intents.
* Installs bulk point-to-point connectivity intents between given ingress/egress devices.
*/
@Command(scope = "onos", name = "push-test-intents",
description = "Installs random intents to test throughput")
......
......@@ -31,7 +31,7 @@ import static org.onosproject.net.DeviceId.deviceId;
import static org.onosproject.net.PortNumber.portNumber;
/**
* Link end-point completer.
* Link destination end-point completer.
*/
public class LinkDstCompleter extends AbstractCompleter {
@Override
......
......@@ -24,7 +24,7 @@ import java.util.List;
import java.util.SortedSet;
/**
* Link end-point completer.
* Link source end-point completer.
*/
public class LinkSrcCompleter extends AbstractCompleter {
@Override
......
......@@ -33,7 +33,7 @@ import org.onosproject.net.intent.IntentService;
import com.google.common.collect.Lists;
/**
* Installs point-to-point connectivity intents.
* Installs bulk point-to-point connectivity intents between random ingress/egress devices.
*/
@Command(scope = "onos", name = "push-random-intents",
description = "Installs random intents to test throughput")
......