Madan Jampani
Committed by Gerrit Code Review

Javadoc fixes

Change-Id: Ia051f4875d5cadbd7e5307bd8bd6ff1df488165d
......@@ -162,8 +162,8 @@ public class DevicePortStatsCommand extends DevicesListCommand {
/**
* Converts bytes to human readable string with Kilo, Mega, Giga, etc.
*
* @param bytes
* @return
* @param bytes input byte array
* @return human readble string
*/
public static String humanReadable(long bytes) {
int unit = 1000;
......@@ -177,8 +177,8 @@ public class DevicePortStatsCommand extends DevicesListCommand {
/**
* Converts bps to human readable format.
*
* @param bps
* @return
* @param bps input rate
* @return human readble string
*/
public static String humanReadableBps(float bps) {
int unit = 1000;
......
......@@ -137,7 +137,7 @@ public interface DeviceStore extends Store<DeviceEvent, DeviceStoreDelegate> {
/**
* Returns the list of delta port statistics of the specified device.
*
* @param deviceId
* @param deviceId device identifier
* @return list of delta port statistics of all ports of the device
*/
List<PortStatistics> getPortDeltaStatistics(DeviceId deviceId);
......
......@@ -127,6 +127,7 @@ public interface ResourceService {
/**
* Returns allocated resources being as children of the specified parent and being the specified resource type.
*
* @param parent parent resource path
* @param cls class to specify a type of resource
* @param <T> type of the resource
* @return non-empty collection of resource allocations if resources are allocated with the subject and type,
......
......@@ -104,6 +104,7 @@ public class Versioned<V> {
* a default value.
* @param versioned versioned object
* @param defaultValue default value to return if versioned object is null
* @param <U> type of the versioned value
* @return versioned value or default value if versioned object is null
*/
public static <U> U valueOrElse(Versioned<U> versioned, U defaultValue) {
......
......@@ -57,6 +57,7 @@ final class ResourceLinkListener implements LinkListener {
* Creates an instance with the specified ResourceAdminService and ExecutorService.
*
* @param adminService instance invoked to register resources
* @param driverService driver service instance
* @param executor executor used for processing resource registration
*/
ResourceLinkListener(ResourceAdminService adminService, DriverService driverService, ExecutorService executor) {
......
......@@ -53,7 +53,7 @@ public class MeteringAgent {
*
* @param primitiveName Type of primitive to be metered
* @param objName Global name of the primitive
* @param activated
* @param activated boolean flag for whether metering is enabled or not
*/
public MeteringAgent(String primitiveName, String objName, boolean activated) {
checkNotNull(objName, "Object name cannot be null");
......@@ -75,6 +75,7 @@ public class MeteringAgent {
* Initializes a specific timer for a given operation.
*
* @param op Specific operation being metered
* @return timer context
*/
public Context startTimer(String op) {
if (!activated) {
......@@ -98,8 +99,8 @@ public class MeteringAgent {
/**
* Constructs Context.
*
* @param context
* @param operation
* @param context context
* @param operation operation name
*/
public Context(Timer.Context context, String operation) {
this.context = context;
......@@ -108,7 +109,7 @@ public class MeteringAgent {
/**
* Stops timer given a specific context and updates all related metrics.
* @param e
* @param e throwable
*/
public void stop(Throwable e) {
if (!activated) {
......
......@@ -589,9 +589,9 @@ public class ECDeviceStore
/**
* Calculate delta statistics by subtracting previous from new statistics.
*
* @param deviceId
* @param prvStats
* @param newStats
* @param deviceId device indentifier
* @param prvStats previous port statistics
* @param newStats new port statistics
* @return PortStatistics
*/
public PortStatistics calcDeltaStats(DeviceId deviceId, PortStatistics prvStats, PortStatistics newStats) {
......
......@@ -867,9 +867,9 @@ public class GossipDeviceStore
/**
* Calculate delta statistics by subtracting previous from new statistics.
*
* @param deviceId
* @param prvStats
* @param newStats
* @param deviceId device identifier
* @param prvStats previous port statistics
* @param newStats new port statistics
* @return PortStatistics
*/
public PortStatistics calcDeltaStats(DeviceId deviceId, PortStatistics prvStats, PortStatistics newStats) {
......
......@@ -26,6 +26,9 @@ public interface TriConsumer<U, V, W> {
/**
* Applies the given arguments to the function.
* @param arg1 first argument
* @param arg2 second argument
* @param arg3 third argument
*/
void accept(U arg1, V arg2, W arg3);
......