Fix Javadoc warnings

Change-Id: Icf8b6b6f77ea80d3975aa975226a178145067adf

@@ -57,7 +57,7 @@ public class PacketLinkRealizedByOptical {
      * @param src source connect point
      * @param dst destination connect point
      * @param intent OpticalCircuitIntent that realizes packet link between src and dst
-     * @return
+     * @return PacketLinkRealizedByOptical instance with specified connect points and OpticalCircuitIntent
      */
     public static PacketLinkRealizedByOptical create(ConnectPoint src, ConnectPoint dst,
                                                      OpticalCircuitIntent intent) {
@@ -76,7 +76,7 @@ public class PacketLinkRealizedByOptical {
      * @param src source connect point
      * @param dst destination connect point
      * @param intent OpticalConnectivityIntent that realizes packet link between src and dst
-     * @return
+     * @return PacketLinkRealizedByOptical instance with specified connect points and OpticalConnectivityIntent
      */
     public static PacketLinkRealizedByOptical create(ConnectPoint src, ConnectPoint dst,
                                                      OpticalConnectivityIntent intent) {

@@ -30,8 +30,9 @@ public class OpticalPathEvent extends AbstractEvent<OpticalPathEvent.Type, Optic
 
     /**
      * Creates OpticalPathEvent object with specified type and subject.
-     * @param type
-     * @param subject
+     *
+     * @param type type of event
+     * @param subject subject of the event
      */
     public OpticalPathEvent(Type type, OpticalConnectivityId subject) {
         super(type, subject);

@@ -55,6 +55,7 @@ public final class OduCltPortHelper {
      * @param number        port number
      * @param isEnabled     port enabled state
      * @param signalType    ODU client signal type
+     * @return              port description
      */
     public static PortDescription oduCltPortDescription(PortNumber number,
                                         boolean isEnabled,
@@ -69,6 +70,7 @@ public final class OduCltPortHelper {
      * @param isEnabled     port enabled state
      * @param signalType    ODU client signal type
      * @param annotations   key/value annotations map
+     * @return              port description
      */
     public static PortDescription oduCltPortDescription(PortNumber number,
                                                         boolean isEnabled,
@@ -93,6 +95,7 @@ public final class OduCltPortHelper {
      * @param base          PortDescription to get basic information from
      * @param signalType    ODU client signal type
      * @param annotations   key/value annotations map
+     * @return              port description
      */
     public static PortDescription oduCltPortDescription(PortDescription base,
                                                         CltSignalType signalType,

@@ -66,6 +66,7 @@ public final class OmsPortHelper {
      * @param maxFrequency  maximum frequency
      * @param grid          grid spacing frequency
      * @param annotations   key/value annotations map
+     * @return              port description
      */
     public static PortDescription omsPortDescription(PortNumber number,
                                               boolean isEnabled,
@@ -93,6 +94,7 @@ public final class OmsPortHelper {
      * @param minFrequency  minimum frequency
      * @param maxFrequency  maximum frequency
      * @param grid          grid spacing frequency
+     * @return              port description
      */
     public static PortDescription omsPortDescription(PortNumber number,
                                               boolean isEnabled,
@@ -110,6 +112,7 @@ public final class OmsPortHelper {
      * @param maxFrequency  maximum frequency
      * @param grid          grid spacing frequency
      * @param annotations   key/value annotations map
+     * @return              port description
      */
     public static PortDescription omsPortDescription(PortDescription base,
                                               Frequency minFrequency,

@@ -55,6 +55,7 @@ public final class OtuPortHelper {
      * @param number        port number
      * @param isEnabled     port enabled state
      * @param signalType    OTU client signal type
+     * @return              port description
      */
     public static PortDescription otuPortDescription(PortNumber number,
                                                      boolean isEnabled,
@@ -69,6 +70,7 @@ public final class OtuPortHelper {
      * @param isEnabled     port enabled state
      * @param signalType    OTU client signal type
      * @param annotations   key/value annotations map
+     * @return              port description
      */
     public static PortDescription otuPortDescription(PortNumber number,
                                                      boolean isEnabled,
@@ -93,6 +95,7 @@ public final class OtuPortHelper {
      * @param base          PortDescription to get basic information from
      * @param signalType    OTU client signal type
      * @param annotations   key/value annotations map
+     * @return              port description
      */
     public static PortDescription otuPortDescription(PortDescription base,
                                                      OtuSignalType signalType,

@@ -32,6 +32,9 @@ public interface PortMapper<P extends Port> {
 
     /**
      * Returns true if this port is capable of being projected as {@code <P>}.
+     *
+     * @param port port
+     * @return true if this port can be projected as the given type
      */
     boolean is(Port port);
 

@@ -76,6 +76,7 @@ public abstract class OchSignalCodec {
     /**
      * Returns a JSON Object representation of this instance.
      *
+     * @param j Och signal object
      * @return JSON Object representing OchSignal
      */
     public static ObjectNode encode(OchSignal j) {

@@ -49,6 +49,7 @@ public interface VtnPortApi {
      * Returns port information from OpenStack with port id.
      *
      * @param portId port id
+     * @param osAccess OpenStack address for OS access
      * @return vtn port; null if it fails to get port information
      */
     // TODO remove this when XOS provides port information
@@ -58,6 +59,7 @@ public interface VtnPortApi {
      * Returns port information from OpenStack with port name.
      *
      * @param portName port name
+     * @param osAccess OpenStack address for OS access
      * @return vtn port; null if it fails to get port information
      */
     // TODO remove this when XOS provides port information

@@ -185,6 +185,7 @@ public interface TunnelDescription extends Description, Annotated {
         /**
          * Returns tunnel interface description builder with a tunnel key.
          *
+         * @param tunnelKey tunnel key
          * @return tunnel description builder
          */
         Builder key(TunnelKey tunnelKey);

@@ -182,6 +182,7 @@ public interface NetworkConfigService
      * Clears the  configuration including queued based on the subject.
      * If does not exists this call has no effect.
      *
+     * @param <S>               type of subject
      * @param subject           configuration subject
      */
     <S> void removeConfig(S subject);
@@ -190,6 +191,7 @@ public interface NetworkConfigService
      * Clears the complete configuration including queued.
      * If does not exists this call has no effect.
      *
+     * @param <S>               type of subject
      */
     <S> void removeConfig();
 }

@@ -155,6 +155,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon
      * Clears the  configuration based on the subject including queued.
      * If does not exists this call has no effect.
      *
+     * @param <S>               type of subject
      * @param subject   configuration subject
      */
     <S> void clearConfig(S subject);
@@ -163,6 +164,7 @@ public interface NetworkConfigStore extends Store<NetworkConfigEvent, NetworkCon
      * Clears the complete configuration including queued.
      * If does not exists this call has no effect.
      *
+     * @param <S>               type of subject
      */
     <S> void clearConfig();
 

@@ -24,7 +24,7 @@ public interface BehaviourClassResolver {
     /**
      * Returns the class corresponding to the specified class name.
      * @param className class className
-     * @return
+     * @return class for the resolver
      */
     Class<? extends Behaviour> getBehaviourClass(String className);
 

@@ -71,6 +71,7 @@ public interface FlowEntry extends FlowRule {
     /**
      * Returns the time this flow rule has been applied.
      *
+     * @param unit time unit the result will be converted to
      * @return time in the requested {@link TimeUnit}
      */
     long life(TimeUnit unit);

@@ -36,6 +36,9 @@ public interface ProbedLinkProvider extends LinkProvider {
     /**
      * Build a stringified MAC address using the ClusterMetadata hash for uniqueness.
      * Form of MAC is "02:eb" followed by four bytes of clusterMetadata hash.
+     *
+     * @param cm cluster metadata
+     * @return stringified mac address
      */
     static String fingerprintMac(ClusterMetadata cm) {
         if (cm == null) {

@@ -94,6 +94,7 @@ public class ResourceConsumerId {
     /**
      * Creates ResourceConsumerId from given value and class.
      *
+     * @param <T> resource consumer class type
      * @param value ID value unique within the given class
      * @param cls class of ResourceConsumer implementation
      * @return created ResourceConsumerId object
@@ -105,6 +106,7 @@ public class ResourceConsumerId {
     /**
      * Creates ResourceConsumerId instance from Identifier object.
      *
+     * @param <T> resource consumer class type
      * @param id identifier object backed by Long value
      * @return created ResourceConsumerId object
      */

@@ -59,6 +59,9 @@ public abstract class ForwardingPort implements Port {
      * call {@code super.toEqualsBuilder(..)} and append fields.
      * To remove field from comparison, override this method
      * or manually implement equals().
+     *
+     * @param that object to compare to
+     * @return builder object
      */
     protected EqualsBuilder toEqualsBuilder(Port that) {
         if (that == null) {

@@ -80,6 +80,7 @@ public interface DistributedPrimitiveCreator {
     /**
      * Creates a new {@code WorkQueue}.
      *
+     * @param <E> work element type
      * @param name work queue name
      * @param serializer serializer
      * @return work queue
@@ -103,4 +104,4 @@ public interface DistributedPrimitiveCreator {
      * @return set of {@code WorkQueue} names
      */
     Set<String> getWorkQueueNames();
-}
\ No newline at end of file
+}

@@ -77,6 +77,9 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
      * Returns true if this map contains at least one key-value pair with key
      * and value specified.
+     *
+     * @param key key
+     * @param value value
      * @return a future whose value will be true if there is a key-value pair
      * with the specified key and value,
      * false otherwise.
@@ -89,6 +92,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * returns true, if the key-value pair already exists then behavior is
      * implementation specific with some implementations allowing duplicates
      * and others ignoring put requests for existing entries.
+     *
      * @param key the key to add
      * @param value the value to add
      * @return a future whose value will be true if the map has changed because
@@ -100,6 +104,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * Removes the key-value pair with the specified values if it exists. In
      * implementations that allow duplicates which matching entry will be
      * removed is undefined.
+     *
      * @param key the key of the pair to be removed
      * @param value the value of the pair to be removed
      * @return a future whose value will be true if the map changed because of
@@ -113,6 +118,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * will remove one matching entry, which one is not defined. Equivalent to
      * repeated calls to {@code remove()} for each key value pair but more
      * efficient.
+     *
      * @param key the key of the pair to be removed
      * @param values the set of values to be removed
      * @return a future whose value will be true if the map changes because of
@@ -124,6 +130,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
      * Removes all values associated with the specified key as well as the key
      * itself.
+     *
      * @param key the key whose key-value pairs will be removed
      * @return a future whose value is the set of values that were removed,
      * which may be empty, if the values did not exist the version will be
@@ -136,6 +143,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * values in the iterable if each key-value pair does not already exist,
      * if the pair does exist the behavior is implementation specific.
      * (Same as repeated puts but with efficiency gains.)
+     *
      * @param key the key to use for all pairs to be added
      * @param values the set of values to be added in pairs with the key
      * @return a future whose value will be true if any change in the map
@@ -148,6 +156,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * Stores all the values in values associated with the key specified,
      * removes all preexisting values and returns a collection of the removed
      * values which may be empty if the entry did not exist.
+     *
      * @param key the key for all entries to be added
      * @param values the values to be associated with the key
      * @return a future whose value will be the collection of removed values,
@@ -158,6 +167,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
 
     /**
      * Removes all key-value pairs, after which it will be empty.
+     *
      * @return a future whose value is irrelevant, simply used to determine if
      * the call has completed
      */
@@ -166,6 +176,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
      * Returns a collection of values associated with the specified key, if the
      * key is not in the map it will return an empty collection.
+     *
      * @param key the key whose associated values will be returned
      * @return a future whose value will be the collection of the values
      * associated with the specified key, the collection may be empty
@@ -175,6 +186,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
     /**
      * Returns a set of the keys contained in this multimap with one or more
      * associated values.
+     *
      * @return a future whose value will be the collection of all keys with one
      * or more associated values, this may be empty
      */
@@ -184,6 +196,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * Returns a multiset of the keys present in this multimap with one or more
      * associated values each. Keys will appear once for each key-value pair
      * in which they participate.
+     *
      * @return a future whose value will be a multiset of the keys, this may
      * be empty
      */
@@ -193,6 +206,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * Returns a collection of values in the set with duplicates permitted, the
      * size of this collection will equal the size of the map at the time of
      * creation.
+     *
      * @return a future whose value will be a collection of values, this may be
      * empty
      */
@@ -200,6 +214,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
 
     /**
      * Returns a collection of each key-value pair in this map.
+     *
      * @return a future whose value will be a collection of all entries in the
      * map, this may be empty
      */
@@ -209,6 +224,7 @@ public interface AsyncConsistentMultimap<K, V> extends DistributedPrimitive {
      * Returns a map of keys to collections of values that reflect the set of
      * key-value pairs contained in the multimap, where the key value pairs
      * would be the key paired with each of the values in the collection.
+     *
      * @return a future whose value will be a map of keys to collections of
      * values, the returned map may be empty.
      */

@@ -102,6 +102,8 @@ public interface StorageService {
 
     /**
      * Returns an instance of {@code WorkQueue} with specified name.
+     *
+     * @param <E> work element type
      * @param name work queue name
      * @param serializer serializer
      *

@@ -61,6 +61,8 @@ public class Task<E> {
 
     /**
      * Maps task from one payload type to another.
+     *
+     * @param <F> future type
      * @param mapper type mapper.
      * @return mapped task.
      */

@@ -499,7 +499,8 @@ public final class AtomixConsistentTreeMapCommands {
 
     /**
      * Returns the smallest key larger than or equal to the specified key.
-     * @param <K>
+     *
+     * @param <K> key type
      */
     @SuppressWarnings("serial")
     public static class CeilingKey<K> extends KeyQuery<K> {

@@ -28,6 +28,7 @@ public interface VoltOnuOperConfig extends HandlerBehaviour {
      * Reboot an ONU in the device.
      *
      * @param target input data in string
+     * @return response string
      */
     String rebootOnu(String target);
 
@@ -35,6 +36,7 @@ public interface VoltOnuOperConfig extends HandlerBehaviour {
      * Operate/release loopback on Ethernet port an ONU in the device.
      *
      * @param target input data in string
+     * @return response string
      */
     String loopbackEthOnu(String target);
 

@@ -41,6 +41,7 @@ public class AlarmEvent extends AbstractEvent<AlarmEvent.Type, Alarm> {
     /**
      * Creates an event due to one alarm.
      *
+     * @param type alarm type
      * @param alarm the alarm related to the event.
      */
     public AlarmEvent(AlarmEvent.Type type, Alarm alarm) {

@@ -30,6 +30,7 @@ public interface AlarmTranslator {
      * Translates message from device into an alarm with appropriate
      * information.
      *
+     * @param deviceId device
      * @param message message from device to translate to alarm
      * @return Alarm with information determined by given message
      */

@@ -224,6 +224,7 @@ public class BgpFlowSpecNlri {
      * Update buffer with identical flow types.
      *
      * @param cb channel buffer
+     * @param bgpFlowSpecNlri flow specification
      */
     public static void updateBufferIdenticalFlowTypes(ChannelBuffer cb, BgpFlowSpecNlri bgpFlowSpecNlri) {
 
@@ -256,6 +257,7 @@ public class BgpFlowSpecNlri {
      * Update buffer with non-identical flow types.
      *
      * @param cb channel buffer
+     * @param bgpFlowSpecNlri flow specification
      */
     public static void updateBufferNonIdenticalFlowTypes(ChannelBuffer cb, BgpFlowSpecNlri bgpFlowSpecNlri) {
         ChannelBuffer flowSpecTmpBuff = ChannelBuffers.dynamicBuffer();

@@ -171,6 +171,7 @@ public class WideCommunityAttrHeader implements BgpValueType {
      *
      * @param c ChannelBuffer
      * @return object of WideCommunityAttrHeader
+     * @throws BgpParseException if a parsing error occurs
      */
     public static WideCommunityAttrHeader read(ChannelBuffer c) throws BgpParseException {
 
@@ -206,4 +207,4 @@ public class WideCommunityAttrHeader implements BgpValueType {
         // TODO Auto-generated method stub
         return 0;
     }
-}
\ No newline at end of file
+}

@@ -81,6 +81,7 @@ public class WideCommunity implements BgpValueType {
     /**
      * Returns object of this class with specified values.
      *
+     * @param wideCommunityHeader community header
      * @param community wide community
      * @param localAsn local ASN number
      * @param contextAsn context ASN number

@@ -80,6 +80,7 @@ public interface RestSBController {
     /**
      * Does a REST POST request with specified parameters to the device.
      *
+     * @param <T>           post return type
      * @param device        device to make the request to
      * @param request       url of the request
      * @param payload       payload of the request as an InputStream

@@ -117,6 +117,7 @@ public final class HexString {
      * If separator is the empty string or null, then no separator will be considered.
      *
      * @param values hex string to be converted
+     * @param separator regex for separator
      * @return converted byte array
      * @throws NumberFormatException if input hex string cannot be parsed
      */

@@ -76,6 +76,8 @@ public final class ImmutableByteSequence {
      * the passed byte array, from/to the given indexes (inclusive).
      *
      * @param original a byte array value
+     * @param fromIdx starting index
+     * @param toIdx ending index
      * @return a new immutable byte sequence
      */
     public static ImmutableByteSequence copyFrom(byte[] original, int fromIdx, int toIdx) {
@@ -239,4 +241,4 @@ public final class ImmutableByteSequence {
     public String toString() {
         return HexString.toHexString(value.array());
     }
-}
\ No newline at end of file
+}

@@ -103,6 +103,7 @@ public class FlowsWebResource extends AbstractWebResource {
      * Criteria description:
      * https://wiki.onosproject.org/display/ONOS/Flow+Rule+Criteria
      *
+     * @param appId application id
      * @param stream flow rules JSON
      * @return status of the request - CREATED if the JSON is correct,
      * BAD_REQUEST if the JSON is invalid