Fix javadoc warnings

Change-Id: I156c861729fd48d5e6792f810c342e1579482c04
This commit is contained in:
Madan Jampani 2015-06-25 10:37:45 -07:00
parent 74d32fdb14
commit 0dbac7af9e
5 changed files with 5 additions and 0 deletions

View File

@ -45,6 +45,7 @@ public interface EdgePortService {
/** /**
* Returns a collection of all edge point for the specified device. * Returns a collection of all edge point for the specified device.
* *
* @param deviceId device identifier
* @return iterable collection of all edge points for the device * @return iterable collection of all edge points for the device
*/ */
Iterable<ConnectPoint> getEdgePoint(DeviceId deviceId); Iterable<ConnectPoint> getEdgePoint(DeviceId deviceId);

View File

@ -39,6 +39,7 @@ public interface ObjectiveContext {
* Invoked when error is encountered while executing the flow objective. * Invoked when error is encountered while executing the flow objective.
* *
* @param objective objective to execute * @param objective objective to execute
* @param error error encountered
*/ */
default void onError(Objective objective, ObjectiveError error) { default void onError(Objective objective, ObjectiveError error) {
} }

View File

@ -91,6 +91,7 @@ public class Versioned<V> {
* Maps this instance into another after transforming its * Maps this instance into another after transforming its
* value while retaining the same version and creationTime. * value while retaining the same version and creationTime.
* @param transformer function to mapping the value * @param transformer function to mapping the value
* @param <U> value type of the returned instance
* @return mapped instance * @return mapped instance
*/ */
public <U> Versioned<U> map(Function<V, U> transformer) { public <U> Versioned<U> map(Function<V, U> transformer) {

View File

@ -59,6 +59,7 @@ public class TransactionManager {
* Constructs a new TransactionManager for the specified database instance. * Constructs a new TransactionManager for the specified database instance.
* *
* @param database database * @param database database
* @param mapBuilder builder for ConsistentMap instances
*/ */
public TransactionManager(Database database, ConsistentMapBuilder<Long, Transaction> mapBuilder) { public TransactionManager(Database database, ConsistentMapBuilder<Long, Transaction> mapBuilder) {
this.database = checkNotNull(database, "database cannot be null"); this.database = checkNotNull(database, "database cannot be null");

View File

@ -129,6 +129,7 @@ public class FlowsWebResource extends AbstractWebResource {
/** /**
* Creates a flow rule from a POST of a JSON string and attempts to apply it. * Creates a flow rule from a POST of a JSON string and attempts to apply it.
* *
* @param deviceId device identifier
* @param stream input JSON * @param stream input JSON
* @return status of the request - CREATED if the JSON is correct, * @return status of the request - CREATED if the JSON is correct,
* BAD_REQUEST if the JSON is invalid * BAD_REQUEST if the JSON is invalid