[Edgent-387] update iotp sample javadoc
- update the overview javadoc samples table
- update the sample/connector/iotp package doc
- update the sample's doc
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpAppClient.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpAppClient.java
index adc7a8f..15508dd 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpAppClient.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpAppClient.java
@@ -31,9 +31,9 @@
import com.ibm.iotf.client.app.EventCallback;
/**
- * A WIoTP ApplicationClient that publishes cmds
- * and subscribes to events for the
- * IotpDeviceSample and IotpGWDeviceSample device samples.
+ * An IBM Watson IoT Platform ApplicationClient that publishes device cmds
+ * and subscribes to device events for
+ * {@link IotpDeviceSample} and {@link IotpGWDeviceSample}.
* <p>
* Usage: {@code [useGw] <app-cfg-path> # see scripts/connectors/iotp/iotp-app-client.cfg}
* <p>
@@ -42,7 +42,9 @@
* The file format is the standard one for IBM Watson IoT Platform.
* <p>
* Note, the config file also contains some additional information for this application.
- * A sample iot-app-client.cfg is in the scripts/connectors/iotp directory.
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about a
+ * prototype application configuration file and running the application.
*/
public class IotpAppClient {
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpDeviceSample.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpDeviceSample.java
index 755890f..2880c99 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpDeviceSample.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpDeviceSample.java
@@ -38,10 +38,10 @@
import com.ibm.iotf.devicemgmt.device.ManagedDevice;
/**
- * Similar to IotpQuickstart2 but for a real/non-quickstart WIoTP account
- * for a registered device AND it subscribes to/prints device cmds.
+ * Send device events and subscribe to device commands as a registered IoT device
+ * using a standard IBM Watson IoT Platform service instance.
* <P>
- * Use IotpAppClient to print published events and generate a command
+ * Use {@link IotpAppClient} to print published events and generate a command
* (start this app before running IotpAppClient).
* <P>
* This sample demonstrates:
@@ -54,9 +54,9 @@
* This connects to your IBM Watson IoT Platform service
* as the Device defined in a device config file.
* The file format is the standard one for IBM Watson IoT Platform.
- * <p>
- * Note, the config file also contains some additional information for this application.
- * A sample iot-device-sample.cfg is in the scripts/connectors/iotp directory.
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about a
+ * prototype device configuration file and running the sample.
*/
public class IotpDeviceSample {
private static final String usage = "[useDeviceClient|useManagedDevice] [useHttp] <device-cfg-path>";
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpGWDeviceSample.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpGWDeviceSample.java
index c03ed25..74ec4d9 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpGWDeviceSample.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpGWDeviceSample.java
@@ -42,11 +42,9 @@
import com.ibm.iotf.devicemgmt.gateway.ManagedGateway;
/**
- * Similar to IotpQuickstart2 but for a real/non-quickstart WIoTP account
- * and a registered IoT Gateway device with connected devices
- * AND it subscribes to and prints received device cmds.
+ * Similar to IotpDeviceSample but behaving as a registered IoT Gateway device.
* <P>
- * Use IotpAppClient to print published events and generate a command
+ * Use {@link IotpAppClient} to print published events and generate a command
* (start this app before running IotpAppClient with the "useGW" option).
* <P>
* This sample demonstrates:
@@ -60,9 +58,9 @@
* This connects to your IBM Watson IoT Platform service
* as the Gateway defined in a gateway config file.
* The file format is the standard one for IBM Watson IoT Platform.
- * <p>
- * Note, the config file also contains some additional information for this application.
- * A sample iot-gwdevice-sample.cfg is in the scripts/connectors/iotp directory.
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about a
+ * prototype gateway device configuration file and running the sample.
*/
public class IotpGWDeviceSample {
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart.java
index 774aadc..3bd2414 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart.java
@@ -43,6 +43,8 @@
* </P>
* A URL is also printed that allows viewing of the data
* as it received by the Quickstart service.
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about running the sample.
*/
public class IotpQuickstart {
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart2.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart2.java
index 9a41601..ac4ee92 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart2.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpQuickstart2.java
@@ -51,6 +51,8 @@
* <P>
* This sample demonstrates using the WIoTP API to initialize the IotpDevice
* connector as well as the ability to publish events using the WIoTP HTTP protocol.
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about running the sample.
*/
public class IotpQuickstart2 {
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpSensors.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpSensors.java
index 5ccb59f..e2f4b12 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpSensors.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/IotpSensors.java
@@ -44,13 +44,14 @@
* is made immediately rather than waiting for a bursty sensor to become
* active.
* <P>
- * This sample requires an IBM Watson IoT Platform service and a device configuration.
- * The device configuration is read from the file {@code device.cfg} in the
- * current directory. <BR>
+ * This sample requires an IBM Watson IoT Platform service and a device configuration.<BR>
* In order to see commands send from IBM Watson IoT Platform
* there must be an analytic application
* that sends commands with the identifier {@code display}.
* </P>
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about a
+ * prototype device configuration file and running the sample.
*/
public class IotpSensors {
diff --git a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/package-info.java b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/package-info.java
index 99e2973..43dcfe9 100644
--- a/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/package-info.java
+++ b/connectors/src/main/java/org/apache/edgent/samples/connectors/iotp/package-info.java
@@ -18,7 +18,22 @@
*/
/**
- * Samples showing device events and commands with IBM Watson IoT Platform.
+ * Samples showing use of the IBM Watson IoT Platform connector
+ * to publish device events and subscribe to device
+ * commands.
+ *
+ * <p>The "Quickstart" samples connect to the IBM Watson IoT Platform
+ * using its Quickstart feature that does not require device registration.
+ * When the samples are run they print out a URL which allows a browser
+ * to see the data being sent from this sample.
+ *
+ * <p>The other samples connect to your IBM Watson IoT Platform service instance
+ * using device and application registrations that you have created with your
+ * service instance.
+ *
+ * <p>See each sample's Javadoc for more information.
+ *
+ * <p>See {@code scripts/connectors/iotp/README} for information about running the samples.
*/
package org.apache.edgent.samples.connectors.iotp;
