Committed by
Gerrit Code Review
Javadoc fixes
Change-Id: Ia051f4875d5cadbd7e5307bd8bd6ff1df488165d
Showing
9 changed files
with
22 additions
and
15 deletions
| ... | @@ -162,8 +162,8 @@ public class DevicePortStatsCommand extends DevicesListCommand { | ... | @@ -162,8 +162,8 @@ public class DevicePortStatsCommand extends DevicesListCommand { |
| 162 | /** | 162 | /** |
| 163 | * Converts bytes to human readable string with Kilo, Mega, Giga, etc. | 163 | * Converts bytes to human readable string with Kilo, Mega, Giga, etc. |
| 164 | * | 164 | * |
| 165 | - * @param bytes | 165 | + * @param bytes input byte array |
| 166 | - * @return | 166 | + * @return human readble string |
| 167 | */ | 167 | */ |
| 168 | public static String humanReadable(long bytes) { | 168 | public static String humanReadable(long bytes) { |
| 169 | int unit = 1000; | 169 | int unit = 1000; |
| ... | @@ -177,8 +177,8 @@ public class DevicePortStatsCommand extends DevicesListCommand { | ... | @@ -177,8 +177,8 @@ public class DevicePortStatsCommand extends DevicesListCommand { |
| 177 | /** | 177 | /** |
| 178 | * Converts bps to human readable format. | 178 | * Converts bps to human readable format. |
| 179 | * | 179 | * |
| 180 | - * @param bps | 180 | + * @param bps input rate |
| 181 | - * @return | 181 | + * @return human readble string |
| 182 | */ | 182 | */ |
| 183 | public static String humanReadableBps(float bps) { | 183 | public static String humanReadableBps(float bps) { |
| 184 | int unit = 1000; | 184 | int unit = 1000; | ... | ... |
| ... | @@ -137,7 +137,7 @@ public interface DeviceStore extends Store<DeviceEvent, DeviceStoreDelegate> { | ... | @@ -137,7 +137,7 @@ public interface DeviceStore extends Store<DeviceEvent, DeviceStoreDelegate> { |
| 137 | /** | 137 | /** |
| 138 | * Returns the list of delta port statistics of the specified device. | 138 | * Returns the list of delta port statistics of the specified device. |
| 139 | * | 139 | * |
| 140 | - * @param deviceId | 140 | + * @param deviceId device identifier |
| 141 | * @return list of delta port statistics of all ports of the device | 141 | * @return list of delta port statistics of all ports of the device |
| 142 | */ | 142 | */ |
| 143 | List<PortStatistics> getPortDeltaStatistics(DeviceId deviceId); | 143 | List<PortStatistics> getPortDeltaStatistics(DeviceId deviceId); | ... | ... |
| ... | @@ -127,6 +127,7 @@ public interface ResourceService { | ... | @@ -127,6 +127,7 @@ public interface ResourceService { |
| 127 | /** | 127 | /** |
| 128 | * Returns allocated resources being as children of the specified parent and being the specified resource type. | 128 | * Returns allocated resources being as children of the specified parent and being the specified resource type. |
| 129 | * | 129 | * |
| 130 | + * @param parent parent resource path | ||
| 130 | * @param cls class to specify a type of resource | 131 | * @param cls class to specify a type of resource |
| 131 | * @param <T> type of the resource | 132 | * @param <T> type of the resource |
| 132 | * @return non-empty collection of resource allocations if resources are allocated with the subject and type, | 133 | * @return non-empty collection of resource allocations if resources are allocated with the subject and type, | ... | ... |
| ... | @@ -104,6 +104,7 @@ public class Versioned<V> { | ... | @@ -104,6 +104,7 @@ public class Versioned<V> { |
| 104 | * a default value. | 104 | * a default value. |
| 105 | * @param versioned versioned object | 105 | * @param versioned versioned object |
| 106 | * @param defaultValue default value to return if versioned object is null | 106 | * @param defaultValue default value to return if versioned object is null |
| 107 | + * @param <U> type of the versioned value | ||
| 107 | * @return versioned value or default value if versioned object is null | 108 | * @return versioned value or default value if versioned object is null |
| 108 | */ | 109 | */ |
| 109 | public static <U> U valueOrElse(Versioned<U> versioned, U defaultValue) { | 110 | public static <U> U valueOrElse(Versioned<U> versioned, U defaultValue) { | ... | ... |
| ... | @@ -57,6 +57,7 @@ final class ResourceLinkListener implements LinkListener { | ... | @@ -57,6 +57,7 @@ final class ResourceLinkListener implements LinkListener { |
| 57 | * Creates an instance with the specified ResourceAdminService and ExecutorService. | 57 | * Creates an instance with the specified ResourceAdminService and ExecutorService. |
| 58 | * | 58 | * |
| 59 | * @param adminService instance invoked to register resources | 59 | * @param adminService instance invoked to register resources |
| 60 | + * @param driverService driver service instance | ||
| 60 | * @param executor executor used for processing resource registration | 61 | * @param executor executor used for processing resource registration |
| 61 | */ | 62 | */ |
| 62 | ResourceLinkListener(ResourceAdminService adminService, DriverService driverService, ExecutorService executor) { | 63 | ResourceLinkListener(ResourceAdminService adminService, DriverService driverService, ExecutorService executor) { | ... | ... |
| ... | @@ -53,7 +53,7 @@ public class MeteringAgent { | ... | @@ -53,7 +53,7 @@ public class MeteringAgent { |
| 53 | * | 53 | * |
| 54 | * @param primitiveName Type of primitive to be metered | 54 | * @param primitiveName Type of primitive to be metered |
| 55 | * @param objName Global name of the primitive | 55 | * @param objName Global name of the primitive |
| 56 | - * @param activated | 56 | + * @param activated boolean flag for whether metering is enabled or not |
| 57 | */ | 57 | */ |
| 58 | public MeteringAgent(String primitiveName, String objName, boolean activated) { | 58 | public MeteringAgent(String primitiveName, String objName, boolean activated) { |
| 59 | checkNotNull(objName, "Object name cannot be null"); | 59 | checkNotNull(objName, "Object name cannot be null"); |
| ... | @@ -75,6 +75,7 @@ public class MeteringAgent { | ... | @@ -75,6 +75,7 @@ public class MeteringAgent { |
| 75 | * Initializes a specific timer for a given operation. | 75 | * Initializes a specific timer for a given operation. |
| 76 | * | 76 | * |
| 77 | * @param op Specific operation being metered | 77 | * @param op Specific operation being metered |
| 78 | + * @return timer context | ||
| 78 | */ | 79 | */ |
| 79 | public Context startTimer(String op) { | 80 | public Context startTimer(String op) { |
| 80 | if (!activated) { | 81 | if (!activated) { |
| ... | @@ -98,8 +99,8 @@ public class MeteringAgent { | ... | @@ -98,8 +99,8 @@ public class MeteringAgent { |
| 98 | /** | 99 | /** |
| 99 | * Constructs Context. | 100 | * Constructs Context. |
| 100 | * | 101 | * |
| 101 | - * @param context | 102 | + * @param context context |
| 102 | - * @param operation | 103 | + * @param operation operation name |
| 103 | */ | 104 | */ |
| 104 | public Context(Timer.Context context, String operation) { | 105 | public Context(Timer.Context context, String operation) { |
| 105 | this.context = context; | 106 | this.context = context; |
| ... | @@ -108,7 +109,7 @@ public class MeteringAgent { | ... | @@ -108,7 +109,7 @@ public class MeteringAgent { |
| 108 | 109 | ||
| 109 | /** | 110 | /** |
| 110 | * Stops timer given a specific context and updates all related metrics. | 111 | * Stops timer given a specific context and updates all related metrics. |
| 111 | - * @param e | 112 | + * @param e throwable |
| 112 | */ | 113 | */ |
| 113 | public void stop(Throwable e) { | 114 | public void stop(Throwable e) { |
| 114 | if (!activated) { | 115 | if (!activated) { | ... | ... |
| ... | @@ -589,9 +589,9 @@ public class ECDeviceStore | ... | @@ -589,9 +589,9 @@ public class ECDeviceStore |
| 589 | /** | 589 | /** |
| 590 | * Calculate delta statistics by subtracting previous from new statistics. | 590 | * Calculate delta statistics by subtracting previous from new statistics. |
| 591 | * | 591 | * |
| 592 | - * @param deviceId | 592 | + * @param deviceId device indentifier |
| 593 | - * @param prvStats | 593 | + * @param prvStats previous port statistics |
| 594 | - * @param newStats | 594 | + * @param newStats new port statistics |
| 595 | * @return PortStatistics | 595 | * @return PortStatistics |
| 596 | */ | 596 | */ |
| 597 | public PortStatistics calcDeltaStats(DeviceId deviceId, PortStatistics prvStats, PortStatistics newStats) { | 597 | public PortStatistics calcDeltaStats(DeviceId deviceId, PortStatistics prvStats, PortStatistics newStats) { | ... | ... |
| ... | @@ -867,9 +867,9 @@ public class GossipDeviceStore | ... | @@ -867,9 +867,9 @@ public class GossipDeviceStore |
| 867 | /** | 867 | /** |
| 868 | * Calculate delta statistics by subtracting previous from new statistics. | 868 | * Calculate delta statistics by subtracting previous from new statistics. |
| 869 | * | 869 | * |
| 870 | - * @param deviceId | 870 | + * @param deviceId device identifier |
| 871 | - * @param prvStats | 871 | + * @param prvStats previous port statistics |
| 872 | - * @param newStats | 872 | + * @param newStats new port statistics |
| 873 | * @return PortStatistics | 873 | * @return PortStatistics |
| 874 | */ | 874 | */ |
| 875 | public PortStatistics calcDeltaStats(DeviceId deviceId, PortStatistics prvStats, PortStatistics newStats) { | 875 | public PortStatistics calcDeltaStats(DeviceId deviceId, PortStatistics prvStats, PortStatistics newStats) { | ... | ... |
| ... | @@ -26,6 +26,9 @@ public interface TriConsumer<U, V, W> { | ... | @@ -26,6 +26,9 @@ public interface TriConsumer<U, V, W> { |
| 26 | 26 | ||
| 27 | /** | 27 | /** |
| 28 | * Applies the given arguments to the function. | 28 | * Applies the given arguments to the function. |
| 29 | + * @param arg1 first argument | ||
| 30 | + * @param arg2 second argument | ||
| 31 | + * @param arg3 third argument | ||
| 29 | */ | 32 | */ |
| 30 | void accept(U arg1, V arg2, W arg3); | 33 | void accept(U arg1, V arg2, W arg3); |
| 31 | 34 | ... | ... |
-
Please register or login to post a comment