You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@edgent.apache.org by dl...@apache.org on 2017/02/06 15:08:18 UTC

[1/2] incubator-edgent git commit: Fix javadoc warnings

Repository: incubator-edgent
Updated Branches:
  refs/heads/master 1e9a9066d -> c23d628fd


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/de43b63d
Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent/tree/de43b63d
Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent/diff/de43b63d

Branch: refs/heads/master
Commit: de43b63dd8ca2821f7e06bbc1a843e7d1c77c5f9
Parents: 1e9a906
Author: Dale LaBossiere <dl...@us.ibm.com>
Authored: Thu Feb 2 16:09:53 2017 -0500
Committer: Dale LaBossiere <dl...@us.ibm.com>
Committed: Thu Feb 2 16:09:53 2017 -0500

----------------------------------------------------------------------
 .../main/java/org/apache/edgent/providers/iot/IotProvider.java   | 2 +-
 .../main/java/org/apache/edgent/providers/iot/package-info.java  | 4 ++--
 2 files changed, 3 insertions(+), 3 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/de43b63d/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java
----------------------------------------------------------------------
diff --git a/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java b/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java
index d00ea6b..de4debb 100644
--- a/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java
+++ b/providers/iot/src/main/java/org/apache/edgent/providers/iot/IotProvider.java
@@ -257,7 +257,7 @@ public class IotProvider implements TopologyProvider,
     /**
      * Get the Preferences node that will be used for the IotProvider with the specified name.
      * @param providerName The value that will be passed into {@link IotProvider#IotProvider(String, TopologyProvider, DirectSubmitter, Function) IotProvider()}
-     * @return
+     * @return Preferences
      */
     public static Preferences getPreferences(String providerName) {
       Preferences classNode = Preferences.userNodeForPackage(IotProvider.class);

http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/de43b63d/providers/iot/src/main/java/org/apache/edgent/providers/iot/package-info.java
----------------------------------------------------------------------
diff --git a/providers/iot/src/main/java/org/apache/edgent/providers/iot/package-info.java b/providers/iot/src/main/java/org/apache/edgent/providers/iot/package-info.java
index 1d7516a..479b121 100644
--- a/providers/iot/src/main/java/org/apache/edgent/providers/iot/package-info.java
+++ b/providers/iot/src/main/java/org/apache/edgent/providers/iot/package-info.java
@@ -62,7 +62,7 @@ under the License.
  * </tr>
  * <tr>
  *    <td headers="cmdIdentifier"><strong>Sample command data</strong></td>
- *    <td colspan=5 headers="type alias op args controlMbean">{@code {"type":"appService","alias":"edgent","op":"submit","args":["Heartbeat",{}]}</td>
+ *    <td colspan=5 headers="type alias op args controlMbean">{@code {"type":"appService","alias":"edgent","op":"submit","args":["Heartbeat",{}]}}</td>
  * </tr>
  * <tr></tr>
  * 
@@ -77,7 +77,7 @@ under the License.
  * </tr>
  * <tr>
  *    <td headers="cmdIdentifier"><strong>Sample command data</strong></td>
- *    <td colspan=5 headers="type alias op args controlMbean">{@code {"type":"job","alias":"Heartbeat","op":"stateChange","args":["CLOSE"]}</td>
+ *    <td colspan=5 headers="type alias op args controlMbean">{@code {"type":"job","alias":"Heartbeat","op":"stateChange","args":["CLOSE"]}}</td>
  * </tr>
  * <tr></tr>
  * </table>


[2/2] incubator-edgent git commit: more cleanup

Posted by dl...@apache.org.
more cleanup

Project: http://git-wip-us.apache.org/repos/asf/incubator-edgent/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-edgent/commit/c23d628f
Tree: http://git-wip-us.apache.org/repos/asf/incubator-edgent/tree/c23d628f
Diff: http://git-wip-us.apache.org/repos/asf/incubator-edgent/diff/c23d628f

Branch: refs/heads/master
Commit: c23d628fd9b233bd0d644f7f47f349707dec2d47
Parents: de43b63
Author: Dale LaBossiere <dl...@us.ibm.com>
Authored: Fri Feb 3 14:33:23 2017 -0500
Committer: Dale LaBossiere <dl...@us.ibm.com>
Committed: Fri Feb 3 14:33:23 2017 -0500

----------------------------------------------------------------------
 .../src/main/java/org/apache/edgent/connectors/iot/Commands.java  | 2 +-
 .../src/main/java/org/apache/edgent/connectors/iot/HeartBeat.java | 3 +++
 .../main/java/org/apache/edgent/connectors/iotp/IotpDevice.java   | 2 +-
 .../org/apache/edgent/runtime/jsoncontrol/JsonControlService.java | 2 +-
 .../apache/edgent/samples/scenarios/iotp/IotpFullScenario.java    | 2 +-
 5 files changed, 7 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/c23d628f/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java
----------------------------------------------------------------------
diff --git a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java
index 4f4c284..22c866b 100644
--- a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java
+++ b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/Commands.java
@@ -19,7 +19,7 @@ under the License.
 package org.apache.edgent.connectors.iot;
 
 /**
- * Devic command identifiers used by Edgent.
+ * Device command identifiers used by Edgent.
  * 
  * @see IotDevice#RESERVED_ID_PREFIX
  */

http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/c23d628f/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/HeartBeat.java
----------------------------------------------------------------------
diff --git a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/HeartBeat.java b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/HeartBeat.java
index 0224b0f..2ff55e6 100644
--- a/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/HeartBeat.java
+++ b/connectors/iot/src/main/java/org/apache/edgent/connectors/iot/HeartBeat.java
@@ -30,6 +30,9 @@ import org.apache.edgent.topology.plumbing.PlumbingStreams;
 
 import com.google.gson.JsonObject;
 
+/**
+ * An IoT device heartbeat event generator.
+ */
 public class HeartBeat {
   private HeartBeat() { };
   

http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/c23d628f/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 5bb62dc..ad26d7d 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
@@ -53,7 +53,7 @@ import com.ibm.iotf.client.device.Command;
  * <em>Note IBM Watson IoT Platform was previously known as
  * IBM Internet of Things Foundation.</em>
  * 
- * @see org.apache.edgent.connectors.iot Edgent generic device model
+ * @see <a href="{@docRoot}/org/apache/edgent/connectors/iot/package-summary.html">Edgent generic device model</a>
  * @see <a href="http://www.ibm.com/internet-of-things/iot-platform.html">IBM Watson IoT Platform</a>
  * @see org.apache.edgent.samples.connectors.iotp.IotpSensors Sample application
  */

http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/c23d628f/runtime/jsoncontrol/src/main/java/org/apache/edgent/runtime/jsoncontrol/JsonControlService.java
----------------------------------------------------------------------
diff --git a/runtime/jsoncontrol/src/main/java/org/apache/edgent/runtime/jsoncontrol/JsonControlService.java b/runtime/jsoncontrol/src/main/java/org/apache/edgent/runtime/jsoncontrol/JsonControlService.java
index 780e173..8dbe02f 100644
--- a/runtime/jsoncontrol/src/main/java/org/apache/edgent/runtime/jsoncontrol/JsonControlService.java
+++ b/runtime/jsoncontrol/src/main/java/org/apache/edgent/runtime/jsoncontrol/JsonControlService.java
@@ -43,7 +43,7 @@ import com.google.gson.JsonPrimitive;
  * to {@link #controlRequest(JsonObject)} to invoke a control
  * operation (method) on a registered MBean.
  * 
- *  @see org.apache.edgent.runtime.jsoncontrol Format of control request operation
+ * @see <a href="{@docRoot}/org/apache/edgent/runtime/jsoncontrol/package-summary.html">Control Request JSON</a>
  */
 public class JsonControlService implements ControlService {
     

http://git-wip-us.apache.org/repos/asf/incubator-edgent/blob/c23d628f/samples/scenarios/src/main/java/org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.java
----------------------------------------------------------------------
diff --git a/samples/scenarios/src/main/java/org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.java b/samples/scenarios/src/main/java/org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.java
index 3155b80..5fd37d9 100644
--- a/samples/scenarios/src/main/java/org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.java
+++ b/samples/scenarios/src/main/java/org/apache/edgent/samples/scenarios/iotp/IotpFullScenario.java
@@ -41,7 +41,7 @@ import org.apache.edgent.samples.connectors.iotp.IotpSensors;
  * </P>
  * 
  * @see org.apache.edgent.topology.mbeans.ApplicationServiceMXBean
- * @see org.apache.edgent.topology.mbeans
+ * @see <a href="{@docRoot}/org/apache/edgent/topology/mbeans/package-summary.html">org.apache.edgent.topology.mbeans</a>
  */
 public class IotpFullScenario {