fix javadoc warnings Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent/commit/47becd22 Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent/tree/47becd22 Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent/diff/47becd22
Branch: refs/heads/master Commit: 47becd22598aa08ce4dd869e28e0ebf97e4ce73b Parents: 3401fbf Author: Dale LaBossiere <dlab...@us.ibm.com> Authored: Thu Feb 23 17:34:57 2017 -0500 Committer: Dale LaBossiere <dlab...@us.ibm.com> Committed: Fri Feb 24 21:53:41 2017 -0500 ---------------------------------------------------------------------- .../org/apache/edgent/connectors/iot/IotGateway.java | 2 +- .../org/apache/edgent/connectors/iotp/IotpDevice.java | 10 ++++++---- .../apache/edgent/connectors/iotp/IotpGateway.java | 14 ++++++++------ 3 files changed, 15 insertions(+), 11 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/47becd22/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/IotGateway.java ---------------------------------------------------------------------- diff --git a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/IotGateway.java b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/IotGateway.java index abaaf8a..9a62f25 100644 --- a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/IotGateway.java +++ b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/IotGateway.java @@ -49,7 +49,7 @@ import com.google.gson.JsonObject; * <p> * Events can be published that are from a connected device's deviceId and commands can be * received for that are targeted for it using - * {@link #eventsForDevice(String, TStream, String, JsonObject, int) eventsForDevice()} + * {@link #eventsForDevice(String, TStream, String, int) eventsForDevice()} * and {@link #commandsForDevice(Set, String...) commandsForDevice()}. * * @see <a href="{@docRoot}/org/apache/edgent/connectors/iot/package-summary.html">Edgent generic IoT device model</a> http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/47becd22/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java ---------------------------------------------------------------------- diff --git a/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java b/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java index 0ea5f06..caab29a 100644 --- a/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java +++ b/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpDevice.java @@ -125,12 +125,13 @@ public class IotpDevice implements IotDevice { * Connecting to the server occurs when the topology is submitted for * execution. * </p> + * <p> + * See the IBM Watson IoT Platform documentation for additional properties. + * </p> * * @param options control options * @param topology * the connector's associated {@code Topology}. - * - * @see the IBM Watson IoT Platform documentation for additional properties. */ public IotpDevice(Topology topology, Properties options) { this.topology = topology; @@ -166,10 +167,11 @@ public class IotpDevice implements IotDevice { * Connecting to the server occurs when the topology is submitted for * execution. * </p> + * <p> + * See the IBM Watson IoT Platform documentation for additional properties. + * </p> * @param topology the connector's associated {@code Topology}. * @param optionsFile File containing connection information. - * - * @see the IBM Watson IoT Platform documentation for additional properties. */ public IotpDevice(Topology topology, File optionsFile) { this.topology = topology; http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/47becd22/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpGateway.java ---------------------------------------------------------------------- diff --git a/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpGateway.java b/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpGateway.java index aee3d71..b2137f2 100644 --- a/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpGateway.java +++ b/connectors/iotp/src/main/java/org/apache/edgent/connectors/iotp/IotpGateway.java @@ -76,12 +76,13 @@ public class IotpGateway implements IotGateway { * Connecting to the server occurs when the topology is submitted for * execution. * </p> + * <p> + * See the IBM Watson IoT Platform documentation for additional properties. + * </p> * * @param options control options * @param topology * the connector's associated {@code Topology}. - * - * @see the IBM Watson IoT Platform documentation for additional properties. */ public IotpGateway(Topology topology, Properties options) { this.topology = topology; @@ -117,10 +118,11 @@ public class IotpGateway implements IotGateway { * Connecting to the server occurs when the topology is submitted for * execution. * </p> + * <p> + * See the IBM Watson IoT Platform documentation for additional properties. + * </p> * @param topology the connector's associated {@code Topology}. * @param optionsFile File containing connection information. - * - * @see the IBM Watson IoT Platform documentation for additional properties. */ public IotpGateway(Topology topology, File optionsFile) { this.topology = topology; @@ -180,7 +182,7 @@ public class IotpGateway implements IotGateway { * * @see #getIotDevice(Map) */ - public static String ATTR_DEVICE_TYPE = "deviceType"; + public static final String ATTR_DEVICE_TYPE = "deviceType"; /** * WIoTP Device Id identifier key. @@ -188,7 +190,7 @@ public class IotpGateway implements IotGateway { * * @see #getIotDevice(Map) */ - public static String ATTR_DEVICE_ID = "deviceId"; + public static final String ATTR_DEVICE_ID = "deviceId"; /** * {@inheritDoc}