Jian Li
Committed by Gerrit Code Review

Fix javadoc warnings

Change-Id: I3de24a04593f47c786f698f5ee1669b3d2f2fdfc
Showing 28 changed files with 47 additions and 7 deletions
......@@ -53,6 +53,7 @@ public final class CordService {
* Default constructor.
*
* @param vNet OpenStack network
* @param subnet OpenStack subnet
* @param hosts host and tunnel ip map
* @param tenantServices list of tenant service ids
*/
......
......@@ -125,6 +125,8 @@ public class CordVtnRuleInstaller {
* @param flowRuleService flow rule service
* @param deviceService device service
* @param driverService driver service
* @param groupService group service
* @param mastershipService mastership service
* @param tunnelType tunnel type
*/
public CordVtnRuleInstaller(ApplicationId appId,
......
......@@ -31,6 +31,7 @@ public interface ControlPlaneMonitorService {
*
* @param controlMetric control plane metric (e.g., control message rate, cpu, memory, etc.)
* @param updateInterval value update interval (time unit will be in minute)
* @param deviceId {@link org.onosproject.net.DeviceId}
*/
void updateMetric(ControlMetric controlMetric, int updateInterval, Optional<DeviceId> deviceId);
......
......@@ -45,6 +45,7 @@ public class MetricsAggregator {
* Instantiates the metrics service
* Initializes all the general metrics for that object
*
* @param metricsService MetricsService reference
* @param type Control metric type
* @param deviceId DeviceId
*/
......
......@@ -116,10 +116,10 @@ public interface DhcpStore {
Iterable<Ip4Address> getAvailableIPs();
/**
* Returns IpAssignment from map.
*
*
* @param hostId
* @return
* @param hostId host identification
* @return IpAssignment
*/
IpAssignment getIpAssignmentFromAllocationMap(HostId hostId);
}
......
......@@ -36,6 +36,7 @@ public class DefaultIpLink extends AbstractModel implements IpLink {
/**
* Constructor to initialize its parameters.
*
* @param providerId provider identification
* @param src link source termination point
* @param dst link destination termination point
* @param linkIdentifier provides link identifier details
......
......@@ -34,6 +34,7 @@ public class IpDeviceIdentifier {
/**
* Constructor to initialize parameters.
*
* @param routeDish routing distinguisher instance
* @param routeInstance routing protocol instance
* @param asNum AS number
* @param domainIdentifier BGP-LS domain
......
......@@ -30,6 +30,7 @@ public class RouterId implements RouteIdentifier {
* Constructor to initialize its parameters.
*
* @param routerId Router ID of designated router
* @param type protocol type
*/
public RouterId(int routerId, ProtocolType type) {
this.routerId = routerId;
......
......@@ -43,6 +43,7 @@ public class AccessDeviceData {
* @param deviceId access device ID
* @param uplink uplink port number
* @param vlan device VLAN ID
* @param defaultVlan default device VLAN ID
*/
public AccessDeviceData(DeviceId deviceId, PortNumber uplink, VlanId vlan,
Optional<VlanId> defaultVlan) {
......
......@@ -40,6 +40,9 @@ public class OltWebResource extends AbstractWebResource {
/**
* Provision a subscriber.
*
* @param device device id
* @param port port number
* @param vlan vlan id
* @return 200 OK
*/
@POST
......@@ -60,6 +63,10 @@ public class OltWebResource extends AbstractWebResource {
/**
* Remove the provisioning for a subscriber.
*
* @param device device id
* @param port port number
* @return 200 OK
*/
@DELETE
@Produces(MediaType.APPLICATION_JSON)
......
......@@ -34,13 +34,14 @@ public interface OpenstackSwitchingService {
/**
* Removes flow rules corresponding to the port removed by Openstack.
*
* @param uuid UUID
*/
void deletePort(String uuid);
/**
* Updates flow rules corresponding to the port information updated by Openstack.
*
* @param openstackPort
* @param openstackPort OpenStack port
*/
void updatePort(OpenstackPort openstackPort);
......
......@@ -72,6 +72,7 @@ public class OpenstackSwitchingRulePopulator {
* @param appId application id
* @param flowObjectiveService FlowObjectiveService reference
* @param deviceService DeviceService reference
* @param restHandler OpenstackRestHandler reference
* @param driverService DriverService reference
*/
public OpenstackSwitchingRulePopulator(ApplicationId appId,
......
......@@ -94,7 +94,8 @@ public class PIMInterface {
/**
* Set the ONOS Interface, it will override a previous value.
*
* @param intf ONOS Interface.
* @param intf ONOS Interface
* @return PIM interface instance
*/
public PIMInterface setInterface(Interface intf) {
onosInterface = intf;
......
......@@ -57,6 +57,7 @@ public class PIMNeighbor {
* Construct a new PIM Neighbor.
*
* @param ipAddr the IP Address of our new neighbor
* @param opts option map
*/
public PIMNeighbor(IpAddress ipAddr, Map<Short, PIMHelloOption> opts) {
this.ipAddr = ipAddr;
......@@ -67,6 +68,7 @@ public class PIMNeighbor {
* Construct a new PIM neighbor.
*
* @param ipAddr the neighbors IP addr
* @param macAddr MAC address
*/
public PIMNeighbor(IpAddress ipAddr, MacAddress macAddr) {
this.ipAddr = ipAddr;
......
......@@ -40,6 +40,7 @@ public class PartitionId implements Comparable<PartitionId> {
* Creates a partition identifier from an integer.
*
* @param id input integer
* @return partition identification
*/
public static PartitionId from(int id) {
return new PartitionId(id);
......
......@@ -171,6 +171,7 @@ public interface NetworkConfigService
* Clears any configuration for the specified subject and configuration
* key. If one does not exist, this call has no effect.
*
* @param subjectClassKey subject class key
* @param subject configuration subject
* @param configKey configuration key
* @param <S> type of subject
......
......@@ -34,6 +34,7 @@ public class ExtensionCriterion implements Criterion {
* Constructor.
*
* @param extensionSelector extension selector
* @param deviceId device identification
*/
public ExtensionCriterion(ExtensionSelector extensionSelector, DeviceId deviceId) {
this.extensionSelector = extensionSelector;
......
......@@ -19,6 +19,8 @@ public class HopCountLinkWeight implements LinkWeight {
/**
* Creates a new hop-count weight with the specified cost of indirect links.
*
* @param indirectLinkCost indirect link cost
*/
public HopCountLinkWeight(int indirectLinkCost) {
this.indirectLinkCost = indirectLinkCost;
......
......@@ -40,6 +40,7 @@ public interface AsyncDistributedSet<E> extends DistributedPrimitive {
* the set is updated.
*
* @param listener listener to notify about set update events
* @return CompletableFuture that is completed when the operation completes
*/
CompletableFuture<Void> addListener(SetEventListener<E> listener);
......@@ -79,6 +80,7 @@ public interface AsyncDistributedSet<E> extends DistributedPrimitive {
/**
* Removes all elements from the set.
* @return CompletableFuture that is completed when the operation completes
*/
CompletableFuture<Void> clear();
......
......@@ -71,6 +71,7 @@ public interface DistributedPrimitive {
/**
* Returns the application owning this primitive.
* @return application id
*/
default ApplicationId applicationId() {
return null;
......
......@@ -62,7 +62,8 @@ final class ResourceDeviceListener implements DeviceListener {
* Creates an instance with the specified ResourceAdminService and ExecutorService.
*
* @param adminService instance invoked to register resources
* @param deviceService {@link DeviceService} to be used.
* @param deviceService {@link DeviceService} to be used
* @param driverService {@link DriverService} to be used
* @param executor executor used for processing resource registration
*/
ResourceDeviceListener(ResourceAdminService adminService, DeviceService deviceService, DriverService driverService,
......
......@@ -61,6 +61,7 @@ public class EventuallyConsistentMapBuilderImpl<K, V>
*
* @param clusterService cluster service
* @param clusterCommunicator cluster communication service
* @param persistenceService persistence service
*/
public EventuallyConsistentMapBuilderImpl(ClusterService clusterService,
ClusterCommunicationService clusterCommunicator,
......
......@@ -150,6 +150,7 @@ public class EventuallyConsistentMapImpl<K, V>
* @param antiEntropyTimeUnit time unit for anti-entropy period
* @param convergeFaster make anti-entropy try to converge faster
* @param persistent persist data to disk
* @param persistenceService persistence service
*/
EventuallyConsistentMapImpl(String mapName,
ClusterService clusterService,
......
......@@ -35,6 +35,7 @@ public interface InterfaceAdminService {
*
* @param connectPoint connect point of the interface
* @param name name of the interface
* @return the result of removal
*/
boolean remove(ConnectPoint connectPoint, String name);
}
......
......@@ -108,7 +108,7 @@ public final class BgpSelectionAlgo implements Comparator<PathAttrNlriDetailsLoc
*
* @param obj1Size object1 AS count
* @param obj2Size object2 AS count
* @return
* @return object with shortest AsPath
*/
int compareAsPath(Integer obj1Size, Integer obj2Size) {
return obj1Size.compareTo(obj2Size);
......
......@@ -186,6 +186,7 @@ public class BgpAppConfig extends Config<ApplicationId> {
/**
* Validates the Bgp peer As number.
*
* @param remoteAs remote As number
* @return true if valid else false
*/
public boolean validateRemoteAs(long remoteAs) {
......@@ -218,6 +219,7 @@ public class BgpAppConfig extends Config<ApplicationId> {
/**
* Validates the Bgp peer holdTime.
*
* @param remoteAs remote As number
* @return true if valid else false
*/
public boolean validatePeerHoldTime(long remoteAs) {
......
......@@ -213,6 +213,8 @@ public abstract class Tools {
/**
* Returns the UTF-8 encoded byte[] representation of a String.
* @param input input string
* @return UTF-8 encoded byte array
*/
public static byte[] getBytesUtf8(String input) {
return input.getBytes(Charsets.UTF_8);
......@@ -220,6 +222,8 @@ public abstract class Tools {
/**
* Returns the String representation of UTF-8 encoded byte[].
* @param input input byte array
* @return UTF-8 encoded string
*/
public static String toStringUtf8(byte[] input) {
return new String(input, Charsets.UTF_8);
......
......@@ -96,6 +96,7 @@ public class MetersWebResource extends AbstractWebResource {
* Returns a meter by the meter id.
*
* @param deviceId device identifier
* @param meterId meter identifier
* @return a meter, return 404 if no entry has been found
* @onos.rsModel Meter
*/
......