Fix Javadoc warnings

Change-Id: Ia5fe7785f76da92abbf940599cbd3d7dc6ac2cc5

core/api/src/main/java/org/onosproject/codec/CodecContext.java

@@ -56,6 +56,7 @@ public interface CodecContext {
      *
      * @param json    JSON to decode
      * @param entityClass entity class
+     * @param <T> entity type
      * @return decoded entity
      */
     default <T> T decode(JsonNode json, Class<T> entityClass) {
@@ -69,6 +70,7 @@ public interface CodecContext {
      *
      * @param entity  entity to encode
      * @param entityClass entity class
+     * @param <T> entity type
      * @return JSON node
      */
     default <T> ObjectNode encode(T entity, Class<T> entityClass) {

core/api/src/main/java/org/onosproject/net/FilteredConnectPoint.java

@@ -32,7 +32,7 @@ public class FilteredConnectPoint {
     /**
      * Creates filtered connect point with default traffic selector.
      *
-     * @param connectPoint
+     * @param connectPoint connect point
      */
     public FilteredConnectPoint(ConnectPoint connectPoint) {
         this.connectPoint = connectPoint;
@@ -61,7 +61,8 @@ public class FilteredConnectPoint {
 
     /**
      * Returns the connection point.
-     * @return
+     *
+     * @return connect point
      */
     public ConnectPoint connectPoint() {
         return connectPoint;

core/api/src/main/java/org/onosproject/net/flow/TrafficTreatment.java

@@ -293,6 +293,7 @@ public interface TrafficTreatment {
         /**
          * Pushes a new VLAN tag using the supplied Ethernet type.
          *
+         * @param ethType ethernet type
          * @return a treatment builder
          */
         Builder pushVlan(EthType ethType);

core/api/src/main/java/org/onosproject/net/flow/criteria/UnresolvedExtensionSelector.java

@@ -32,6 +32,7 @@ public class UnresolvedExtensionSelector extends AbstractExtension implements Ex
     /**
      * Creates a new unresolved extension selector with given data in byte form.
      *
+     * @param arraybyte byte data for the extension selector
      * @param type unresolved extension data type
      */
     public UnresolvedExtensionSelector(byte[] arraybyte, ExtensionSelectorType type) {

core/api/src/main/java/org/onosproject/net/flow/instructions/UnresolvedExtensionTreatment.java

@@ -32,6 +32,7 @@ public class UnresolvedExtensionTreatment extends AbstractExtension implements E
     /**
      * Creates a new unresolved extension treatment with given data in byte form.
      *
+     * @param arraybyte byte data for treatment
      * @param type unresolved extension data type
      */
     public UnresolvedExtensionTreatment(byte[] arraybyte, ExtensionTreatmentType type) {

core/api/src/main/java/org/onosproject/net/group/GroupBucket.java

@@ -79,10 +79,11 @@ public interface GroupBucket {
     long bytes();
 
     /**
-     * Returns whether the given GroupBucket has the same parameters (weight,
+     * Returns whether the given group bucket has the same parameters (weight,
      * watchPort and watchGroup) as this.
      *
-     * @param other GroupBucket to compare
+     * @param other group bucket to compare
+     * @return true if this bucket has the same parameters as other, false otherwise
      */
     boolean hasSameParameters(GroupBucket other);
 }

core/api/src/main/java/org/onosproject/net/group/GroupStore.java

@@ -187,6 +187,8 @@ public interface GroupStore extends Store<GroupEvent, GroupStoreDelegate> {
 
     /**
      * Indicates failover within a failover group.
+     *
+     * @param failoverGroups groups to notify
      */
     void notifyOfFailovers(Collection<Group> failoverGroups);
 }

core/api/src/main/java/org/onosproject/net/host/InterfaceIpAddress.java

@@ -164,6 +164,8 @@ public class InterfaceIpAddress {
     /**
      * Compute the IP broadcast address.
      *
+     * @param ipAddress base IP address
+     * @param subnetAddress subnet specification
      * @return the IP broadcast address
      */
     public static IpAddress computeBroadcastAddress(IpAddress ipAddress, IpPrefix subnetAddress) {

core/api/src/main/java/org/onosproject/net/intent/FlowRuleIntent.java

@@ -54,6 +54,7 @@ public class FlowRuleIntent extends Intent {
      * @param appId application id
      * @param flowRules flow rules to be set
      * @param resources network resource to be set
+     * @param type protection type
      */
     public FlowRuleIntent(ApplicationId appId, List<FlowRule> flowRules, Collection<NetworkResource> resources,
                           PathIntent.ProtectionType type) {
@@ -82,6 +83,7 @@ public class FlowRuleIntent extends Intent {
      * @param key       key
      * @param flowRules flow rules
      * @param resources network resources
+     * @param primary   primary protection type
      */
     public FlowRuleIntent(ApplicationId appId, Key key, Collection<FlowRule> flowRules,
                           Collection<NetworkResource> resources, PathIntent.ProtectionType primary) {
@@ -93,6 +95,9 @@ public class FlowRuleIntent extends Intent {
     /**
      * Creates a flow rule intent with all the same characteristics as the given
      * one except for the flow rule type.
+     *
+     * @param intent original flow rule intent
+     * @param type   new protection type
      */
     public FlowRuleIntent(FlowRuleIntent intent, PathIntent.ProtectionType type) {
         this(intent.appId(), intent.key(), intent.flowRules(),

core/api/src/main/java/org/onosproject/net/intent/WorkPartitionService.java

@@ -30,20 +30,23 @@ public interface WorkPartitionService
     extends ListenerService<WorkPartitionEvent, WorkPartitionEventListener> {
 
     /**
-     * Returns whether a given id maps to a partition owned by this
+     * Returns whether a given identifier maps to a partition owned by this
      * instance.
      *
-     * @param id id
-     * @param hasher function that maps id to a long value
-     * @return {@code true} if the id maps to a partition owned by this instance, otherwise {@code false}
+     * @param id identifier
+     * @param hasher function that maps identifier to a long value
+     * @param <K> entity type
+     * @return true if the identifier maps to a partition owned
+     *         by this instance, otherwise false
      */
     <K> boolean isMine(K id, Function<K, Long> hasher);
 
     /**
-     * Returns the owner for a given id.
+     * Returns the owner for a given identifier.
      *
-     * @param id id to query
+     * @param id identifier to query
      * @param hasher function that maps id to a long value
+     * @param <K> entity type
      * @return the leader node identifier
      */
     <K> NodeId getLeader(K id, Function<K, Long> hasher);

core/api/src/main/java/org/onosproject/net/intent/constraint/ProtectionConstraint.java

@@ -61,7 +61,7 @@ public class ProtectionConstraint implements Constraint {
     /**
      * Returns protection constraint.
      *
-     * @return
+     * @return protection constraint
      */
     public static ProtectionConstraint protection() {
         return PROTECTION_CONSTRAINT;

core/common/src/main/java/org/onosproject/codec/impl/DecodeInstructionCodecHelper.java

@@ -68,6 +68,7 @@ public final class DecodeInstructionCodecHelper {
      * Creates a decode instruction codec object.
      *
      * @param json JSON object to decode
+     * @param context codec context
      */
     public DecodeInstructionCodecHelper(ObjectNode json, CodecContext context) {
         this.json = json;

core/net/src/main/java/org/onosproject/net/intent/impl/compiler/PointToPointIntentCompiler.java

@@ -336,6 +336,9 @@ public class PointToPointIntentCompiler
 
     /**
      * Creates group key unique to each intent.
+     *
+     * @param intentId identifier of intent to get a key for
+     * @return unique group key for the intent identifier
      */
     public static GroupKey makeGroupKey(IntentId intentId) {
         ByteBuffer buffer = ByteBuffer.allocate(Long.BYTES);

core/store/persistence/src/main/java/org/onosproject/persistence/impl/PersistenceException.java

@@ -22,6 +22,8 @@ package org.onosproject.persistence.impl;
 public class PersistenceException extends RuntimeException {
     /**
      * Throws an exception with the specified message.
+     *
+     * @param s message for exception
      */
     public PersistenceException(String s) {
         super(s);

incubator/api/src/main/java/org/onosproject/incubator/net/dpi/DpiStatInfo.java

@@ -136,6 +136,8 @@ public class DpiStatInfo {
 
     /**
      * Sets the traffic statistic information.
+     *
+     * @param trafficStatistics traffic statistics
      */
     public void setTrafficStatistics(TrafficStatInfo trafficStatistics) {
         this.trafficStatistics = trafficStatistics;
@@ -143,6 +145,8 @@ public class DpiStatInfo {
 
     /**
      * Sets the detected protocols statistic information.
+     *
+     * @param detectedProtos detected protocols statistics
      */
     public void setDetectedProtos(List<ProtocolStatInfo> detectedProtos) {
         this.detectedProtos = detectedProtos;
@@ -150,6 +154,8 @@ public class DpiStatInfo {
 
     /**
      * Sets the known flows information.
+     *
+     * @param knownFlows known flows
      */
     public void setKnownFlows(List<FlowStatInfo> knownFlows) {
         this.knownFlows = knownFlows;
@@ -157,6 +163,8 @@ public class DpiStatInfo {
 
     /**
      * Sets the unknown flows information.
+     *
+     * @param unknownFlows unknown flows
      */
     public void setUnknownFlows(List<FlowStatInfo> unknownFlows) {
         this.unknownFlows = unknownFlows;

incubator/api/src/main/java/org/onosproject/incubator/net/dpi/DpiStatisticsManagerService.java

@@ -42,6 +42,7 @@ public interface DpiStatisticsManagerService {
     /**
      * Gets the last N(Max = 100) DpiStatistics in the Store list.
      *
+     * @param lastN maximum number to fetch
      * @return the List of DpiStatistics object class
      */
     List<DpiStatistics> getDpiStatistics(int lastN);
@@ -77,6 +78,7 @@ public interface DpiStatisticsManagerService {
     /**
      * Adds DpiStatistics at the end of the Store list.
      *
+     * @param ds statistics to add
      * @return the added DpiStatistics object class
      */
     DpiStatistics addDpiStatistics(DpiStatistics ds);

incubator/api/src/main/java/org/onosproject/incubator/net/dpi/FlowStatInfo.java

@@ -52,6 +52,16 @@ public class FlowStatInfo {
 
     /**
      * Constructor for FlowStatInfo class specified with flow statistic parameters.
+     *
+     * @param protocol protocol
+     * @param hostAName host A name
+     * @param hostAPort host A port
+     * @param hostBName host B name
+     * @param hostBPort host B port
+     * @param detectedProtocol detected protocol
+     * @param detectedProtocolName detected protocol name
+     * @param packets packet count
+     * @param bytes byte count
      */
     public FlowStatInfo(String protocol, String hostAName, int hostAPort, String hostBName, int hostBPort,
                         int detectedProtocol, String detectedProtocolName, long packets, long bytes) {
@@ -70,6 +80,17 @@ public class FlowStatInfo {
 
     /**
      * Constructor for FlowStatInfo class specified with flow statistic parameters and hostServerName.
+     *
+     * @param protocol protocol
+     * @param hostAName host A name
+     * @param hostAPort host A port
+     * @param hostBName host B name
+     * @param hostBPort host B port
+     * @param detectedProtocol detected protocol
+     * @param detectedProtocolName detected protocol name
+     * @param packets packet count
+     * @param bytes byte count
+     * @param hostServerName host server name
      */
     public FlowStatInfo(String protocol, String hostAName, int hostAPort, String hostBName, int hostBPort,
                         int detectedProtocol, String detectedProtocolName, long packets, long bytes,

incubator/api/src/main/java/org/onosproject/incubator/net/dpi/TrafficStatInfo.java

@@ -66,6 +66,22 @@ public class TrafficStatInfo {
 
     /**
      * Constructor for TrafficStatInfo class specified with traffic statistic parameters.
+     *
+     * @param ethernetBytes ethernet byte count
+     * @param discardedBytes discarded byte count
+     * @param ipPackets IP packet count
+     * @param totalPackets total packet count
+     * @param ipBytes total IP byte count
+     * @param avgPktSize average packet size
+     * @param uniqueFlows unique flows count
+     * @param tcpPackets TCP packet count
+     * @param udpPackets UDP packet count
+     * @param trafficThroughputPps traffic throughput PPS
+     * @param trafficThroughputBps traffic throughput BPS
+     * @param dpiThroughputPps DPI throughput PPS
+     * @param dpiThroughputBps DPI throughput BPS
+     * @param trafficDurationSec traffic duration in seconds
+     * @param guessedFlowProtos guess flow protocols
      */
     public TrafficStatInfo(long ethernetBytes, long discardedBytes, long ipPackets, long totalPackets,
                            long ipBytes, int avgPktSize, int uniqueFlows, long tcpPackets, long udpPackets,

incubator/net/src/main/java/org/onosproject/incubator/net/neighbour/impl/DefaultNeighbourMessageContext.java

@@ -157,6 +157,7 @@ public class DefaultNeighbourMessageContext implements NeighbourMessageContext {
      *
      * @param eth input Ethernet frame
      * @param inPort in port
+     * @param actions actions to take
      * @return MessageContext if the packet was ARP or NDP, otherwise null
      */
     public static NeighbourMessageContext createContext(Ethernet eth,
@@ -176,6 +177,7 @@ public class DefaultNeighbourMessageContext implements NeighbourMessageContext {
      *
      * @param eth input Ethernet frame that is thought to be ARP
      * @param inPort in port
+     * @param actions actions to take
      * @return MessageContext object if the packet was a valid ARP packet,
      * otherwise null
      */
@@ -209,6 +211,7 @@ public class DefaultNeighbourMessageContext implements NeighbourMessageContext {
      *
      * @param eth input Ethernet frame that is thought to be NDP
      * @param inPort in port
+     * @param actions actions to take
      * @return MessageContext object if the packet was a valid NDP packet,
      * otherwise null
      */

protocols/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/OvsdbClientService.java

@@ -72,7 +72,7 @@ public interface OvsdbClientService extends OvsdbRpc {
     /**
      * Drops the configuration for mirror.
      *
-     * @param mirroringName
+     * @param mirroringName name of mirror to drop
      */
     void dropMirror(MirroringName mirroringName);
 

protocols/ovsdb/api/src/main/java/org/onosproject/ovsdb/controller/driver/DefaultOvsdbClient.java

@@ -734,7 +734,7 @@ public class DefaultOvsdbClient implements OvsdbProviderService, OvsdbClientServ
     /**
      * Drops the configuration for mirror.
      *
-     * @param mirroringName
+     * @param mirroringName name of mirror to drop
      */
     @Override
     public void dropMirror(MirroringName mirroringName) {

protocols/pcep/api/src/main/java/org/onosproject/pcep/controller/PcepClientController.java

@@ -130,7 +130,7 @@ public interface PcepClientController {
     /**
      * Creates label stack for ERO object from network resource.
      *
-     * @param labelStack
+     * @param labelStack label stack
      * @param path (hop list)
      * @return list of ERO sub-objects
      */

protocols/pcep/ctl/src/main/java/org/onosproject/pcep/controller/impl/BasicPceccHandler.java

@@ -124,7 +124,9 @@ public final class BasicPceccHandler {
      * Initialization of label manager and pce store.
      *
      * @param labelRsrcService label resource service
+     * @param deviceService device service
      * @param pceStore pce label store
+     * @param clientController client controller
      */
     public void initialize(LabelResourceService labelRsrcService,
                            DeviceService deviceService,

protocols/pcep/ctl/src/main/java/org/onosproject/pcep/controller/impl/PceccSrTeBeHandler.java

@@ -108,6 +108,7 @@ public final class PceccSrTeBeHandler {
      *
      * @param labelRsrcAdminService label resource admin service
      * @param labelRsrcService label resource service
+     * @param clientController client controller
      * @param pceStore PCE label store
      * @param deviceService device service
      */

protocols/pcep/ctl/src/main/java/org/onosproject/pcep/controller/impl/PcepClientControllerImpl.java

@@ -791,7 +791,7 @@ public class PcepClientControllerImpl implements PcepClientController {
     /**
      * Creates label stack for ERO object from network resource.
      *
-     * @param labelStack
+     * @param labelStack label stack
      * @param path (hop list)
      * @return list of ERO subobjects
      */

utils/misc/src/main/java/org/onlab/util/PredictableExecutor.java

@@ -246,6 +246,7 @@ public class PredictableExecutor
      *
      * @param callable {@link Callable}
      * @param hint hint value
+     * @param <T> entity type
      * @return {@link PickyCallable}
      */
     public static <T> PickyCallable<T> picky(Callable<T> callable, int hint) {
@@ -257,6 +258,7 @@ public class PredictableExecutor
      *
      * @param callable {@link Callable}
      * @param hint hint function
+     * @param <T> entity type
      * @return {@link PickyCallable}
      */
     public static <T> PickyCallable<T> picky(Callable<T> callable, Function<Callable<T>, Integer> hint) {
@@ -307,6 +309,9 @@ public class PredictableExecutor
 
         /**
          * Same as {@link FutureTask#FutureTask(Runnable, Object)}.
+         *
+         * @param runnable work to do
+         * @param value result
          */
         public PickyFutureTask(Runnable runnable, T value) {
             super(runnable, value);
@@ -315,6 +320,8 @@ public class PredictableExecutor
 
         /**
          * Same as {@link FutureTask#FutureTask(Callable)}.
+         *
+         * @param callable work to be done
          */
         public PickyFutureTask(Callable<T> callable) {
             super(callable);

web/api/src/main/java/org/onosproject/rest/resources/DpisWebResource.java

@@ -76,6 +76,7 @@ public class DpisWebResource extends AbstractWebResource {
     /**
      * Gets the latest dpi statistics.
      *
+     * @param topn max size
      * @return 200 OK with a dpi statistics
      * @onos.rsModel DpiStatistics
      */
@@ -156,6 +157,7 @@ public class DpisWebResource extends AbstractWebResource {
     /**
      * Gets the latest detected protocol statistics only.
      *
+     * @param topn max size
      * @return 200 OK with a protocol statistics
      * @onos.rsModel ProtocolStatistics
      */
@@ -196,6 +198,7 @@ public class DpisWebResource extends AbstractWebResource {
     /**
      * Gets the latest known flows statistics only.
      *
+     * @param topn max size
      * @return 200 OK with a known flow statistics
      * @onos.rsModel KnownFlowStatistics
      */
@@ -236,6 +239,7 @@ public class DpisWebResource extends AbstractWebResource {
     /**
      * Gets the latest unknown flows statistics only.
      *
+     * @param topn max size
      * @return 200 OK with an unknown flow statistics
      * @onos.rsModel UnknownFlowStatistics
      */