From e440dad54b94ce0b7e2d5bbd4273e53db4132ee9 Mon Sep 17 00:00:00 2001 From: Dale LaBossiere Date: Thu, 22 Jun 2017 16:10:17 -0400 Subject: [PATCH] [Edgent-424] Cleanup things maven-javadoc-plugin 2.10.4 complains about Seen when failOnError is enabled - remove cross project links to non-dependent projects - remove anchor refs from @see - replace problem '>' with > - remove problem

--- .../edgent/analytics/math3/Aggregations.java | 14 +++++++------- .../edgent/analytics/math3/json/JsonAnalytics.java | 2 +- .../edgent/execution/mbeans/PeriodMXBean.java | 2 +- .../edgent/execution/services/ControlService.java | 2 +- .../java/org/apache/edgent/topology/TWindow.java | 2 -- .../apache/edgent/topology/json/JsonFunctions.java | 1 + .../edgent/topology/mbeans/package-info.java | 12 ++++++++---- .../edgent/topology/plumbing/PlumbingStreams.java | 2 +- .../connectors/command/runtime/ProcessReader.java | 4 ++-- .../org/apache/edgent/connectors/iot/Commands.java | 4 ++-- .../apache/edgent/connectors/iotp/IotpDevice.java | 9 +++++---- .../edgent/test/connectors/mqtt/MqttOpenTest.java | 2 +- .../apache/edgent/providers/iot/IotProvider.java | 4 ++-- .../org/apache/edgent/streamscope/StreamScope.java | 2 +- .../edgent/streamscope/StreamScopeRegistry.java | 2 +- .../mbeans/StreamScopeRegistryMXBean.java | 2 +- 16 files changed, 35 insertions(+), 31 deletions(-) diff --git a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java index 4250e831..bcc9ea06 100644 --- a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java +++ b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/Aggregations.java @@ -60,12 +60,12 @@ Licensed to the Apache Software Foundation (ASF) under one * double getTemp() {...}; * double getPressure() {...}; * ... }; - *TStream<SensorReading> readings = ... - *TWindow<SensorReading,Integer> window = sensorReadings.last(5, Functions.unpartitioned()); - *TStream<MvResultMap> aggregations = window.batch( - * (list, partition) -> { - * ResultMap pressureResults = Aggregations.aggregateN(list, t -> t.getPressure(), Statistic2.MEAN, Regression2.SLOPE)); - * ResultMap tempResults = Aggregations.aggregateN(list, t -> t.getTemp(), Statistic2.MAX)); + *TStream<SensorReading> readings = ... + *TWindow<SensorReading,Integer> window = sensorReadings.last(5, Functions.unpartitioned()); + *TStream<MvResultMap> aggregations = window.batch( + * (list, partition) -> { + * ResultMap pressureResults = Aggregations.aggregateN(list, t -> t.getPressure(), Statistic2.MEAN, Regression2.SLOPE)); + * ResultMap tempResults = Aggregations.aggregateN(list, t -> t.getTemp(), Statistic2.MAX)); * MvResultMap results = Aggregations.newMvResults(); * results.put("pressure", pressureResults); * results.put("temp", tempResults); @@ -98,7 +98,7 @@ Licensed to the Apache Software Foundation (ASF) under one *

As a result, using JsonAnalytics for simple cases can be a bit unintuitive and cumbersome. * *

For example, to JsonAnalytics for a simple case of a continuous aggregation - * of {@code TStream} => {@code TStream} of MEAN values: + * of {@code TStream} => {@code TStream} of MEAN values: * * 

{@code
  *  TStream pressureReadings = ...
diff --git a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java
index cfe1a783..8335757a 100644
--- a/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java
+++ b/analytics/math3/src/main/java/org/apache/edgent/analytics/math3/json/JsonAnalytics.java
@@ -253,7 +253,7 @@ BiFunction, K, JsonObject> aggregateList(
      * @param resultPartitionKeyProperty name of the partition key property in the result
      * @param resultProperty name of the aggregation results property in the result
      * @param aggregateSpecs see {@link #mkAggregationSpec(String, JsonUnivariateAggregate...) mkAggregationSpec()}
-     * @return TStream with aggregation results
+     * @return TStream<JsonObject> with aggregation results
      * 
      * @see #mvAggregateList(String, String, List) mvAggregateList()
      * @see #mkAggregationSpec(String, JsonUnivariateAggregate...) mkAggregationSpec()
diff --git a/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java b/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java
index 54d3b5be..6fe58e7e 100644
--- a/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java
+++ b/api/execution/src/main/java/org/apache/edgent/execution/mbeans/PeriodMXBean.java
@@ -31,7 +31,7 @@ Licensed to the Apache Software Foundation (ASF) under one
  * {@link org.apache.edgent.execution.services.ControlService ControlService}.
  * 

  * 
- * @see org.apache.edgent.topology.Topology#poll(org.apache.edgent.function.Supplier, long, TimeUnit)
+ * See {@code org.apache.edgent.topology.Topology.poll(org.apache.edgent.function.Supplier, long, TimeUnit)}
  */
 public interface PeriodMXBean {
     
diff --git a/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java b/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java
index 635ae925..66710171 100644
--- a/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java
+++ b/api/execution/src/main/java/org/apache/edgent/execution/services/ControlService.java
@@ -30,7 +30,7 @@ Licensed to the Apache Software Foundation (ASF) under one
  * 

  * Different implementations of the control service provide the mechanism
  * to execute methods of the control interfaces. For example
- * {@link org.apache.edgent.runtime.jmxcontrol.JMXControlService JMXControlService}
+ * {@code JMXControlService}
  * registers the MBeans in the JMX platform MBean server.
  * 

  * The control service is intended to allow remote execution of a control interface
diff --git a/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java b/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java
index 2665a76b..5c61027b 100644
--- a/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java
+++ b/api/topology/src/main/java/org/apache/edgent/topology/TWindow.java
@@ -64,7 +64,6 @@ public interface TWindow extends TopologyElement {
      * empty if the eviction results in an empty partition.
      * 
      * A non-null {@code aggregator} result is added to the returned stream.
-     * 

      * 

      * Thus the returned stream will contain a sequence of tuples where the
      * most recent tuple represents the most up to date aggregation of a
@@ -93,7 +92,6 @@ public interface TWindow extends TopologyElement {
      * 
      * A non-null {@code batcher} result is added to the returned stream.
      * The partition's contents are cleared after a batch is processed.
-     * 

      * 

      * Thus the returned stream will contain a sequence of tuples where the
      * most recent tuple represents the most up to date aggregation of a
diff --git a/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java b/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java
index 37a9eeae..fe744ec0 100644
--- a/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java
+++ b/api/topology/src/main/java/org/apache/edgent/topology/json/JsonFunctions.java
@@ -101,6 +101,7 @@ public static Function unpartitioned() {
      * 
Returns a Function whose {@code apply(T v)} returns a JsonObject having 
      * a single property named {@code propName} with the value of {@code v}.
      * 
+     * @param  type of number
      * @param propName property name
      * @return the Function
      */
diff --git a/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java b/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java
index e5035c38..52cc4a53 100644
--- a/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java
+++ b/api/topology/src/main/java/org/apache/edgent/topology/mbeans/package-info.java
@@ -18,6 +18,10 @@ Licensed to the Apache Software Foundation (ASF) under one
 */
 /**
  * Controls for executing topologies.
+ * 

+ * The "Attribute Name" column values below correspond to {@code KEY} values defined
+ * in {@code org.apache.edgent.runtime.jsoncontrol.JsonControlService}.
+ * 
  * 
Application Service 

  * {@linkplain org.apache.edgent.topology.services.ApplicationService Application service}
  * allows an application to be registered
@@ -39,26 +43,26 @@ Licensed to the Apache Software Foundation (ASF) under one
  *    Description
  *  
  * 
- *    {@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#TYPE_KEY type}
+ *    {@code type}
  *    String
  *    {@link org.apache.edgent.topology.mbeans.ApplicationServiceMXBean#TYPE appService}
  *    {@code ApplicationServiceMXBean} control MBean type.
  *  
  *  
- *    {@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#OP_KEY op}
+ *    {@code op}
  *    String
  *    {@code submit}
  *    Invoke {@link org.apache.edgent.topology.mbeans.ApplicationServiceMXBean#submit(String, String) submit} operation
  *    against the control MBean.
  *  
  *  
- *    {@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#ALIAS_KEY alias}
+ *    {@code alias}
  *    String
  *    Alias of control MBean.
  *    Default is {@link org.apache.edgent.topology.services.ApplicationService#ALIAS edgent}.
  *  
  *  
- *    {@link org.apache.edgent.runtime.jsoncontrol.JsonControlService#ARGS_KEY args}
+ *    {@code args}
  *    List
  *    String: application name
  *    Registered application to submit.
diff --git a/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java b/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java
index e551642e..0df80ad3 100644
--- a/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java
+++ b/api/topology/src/main/java/org/apache/edgent/topology/plumbing/PlumbingStreams.java
@@ -557,7 +557,7 @@ public static  TStream parallel(TStream stream, int width, ToIntFunct
      * }
*

* Note, this implementation requires that the splitter is used from - * only a single JVM. The {@link org.apache.edgent.providers.direct.DirectProvider DirectProvider} + * only a single JVM. The {@code org.apache.edgent.providers.direct.DirectProvider} * provider meets this requirement. *

* diff --git a/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java b/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java index 47a2c592..e4560f07 100644 --- a/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java +++ b/connectors/command/src/main/java/org/apache/edgent/connectors/command/runtime/ProcessReader.java @@ -30,8 +30,8 @@ Licensed to the Apache Software Foundation (ASF) under one /** * A {@code Supplier>} for ingesting a process's output. *

- * The iterator returned by {@link Iterable#iterator()) returns - * {@hasNext()==true} until a read from {@link Process#getInputStream()} + * The iterator returned by {@link Iterable#iterator()} returns + * {@code hasNext()==true} until a read from {@link Process#getInputStream()} * returns EOF or an IOError. */ class ProcessReader implements Supplier> { 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 22c866b4..0f8626ae 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 @@ -30,12 +30,12 @@ public interface Commands { *
* The command payload is used to invoke operations * against control MBeans using an instance of - * {@link org.apache.edgent.runtime.jsoncontrol.JsonControlService}. + * {@code org.apache.edgent.runtime.jsoncontrol.JsonControlService}. *
* Value is {@value}. * * @see org.apache.edgent.execution.services.ControlService - * @see org.apache.edgent.providers.iot.IotProvider + * See {@code org.apache.edgent.providers.iot.IotProvider} */ String CONTROL_SERVICE = IotDevice.RESERVED_ID_PREFIX + "Control"; 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 caab29a6..621b3420 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 @@ -51,7 +51,7 @@ Licensed to the Apache Software Foundation (ASF) under one * scale message hub that provides a device model on top of MQTT. * {@code IotpDevice} implements the generic device model {@link IotDevice} * and thus can be used as a connector for - * {@link org.apache.edgent.providers.iot.IotProvider}. + * {@code org.apache.edgent.providers.iot.IotProvider}. *
* Note IBM Watson IoT Platform was previously known as * IBM Internet of Things Foundation. @@ -81,8 +81,9 @@ Licensed to the Apache Software Foundation (ASF) under one * for details of changes that occurred to device event payloads * and how to revert the behavior if needed. *

- * @see Edgent generic device model - * @see org.apache.edgent.samples.connectors.iotp.IotpSensors Sample application + * See Edgent generic device model + *

+ * See {@code org.apache.edgent.samples.connectors.iotp.IotpSensors} Sample application */ public class IotpDevice implements IotDevice { @@ -199,7 +200,7 @@ public IotpDevice(Topology topology, DeviceClient deviceClient) { * @return Connector to the Quickstart service. * * @see Quickstart - * @see org.apache.edgent.samples.connectors.iotp.IotpQuickstart Quickstart sample application + * See {@code org.apache.edgent.samples.connectors.iotp.IotpQuickstart Quickstart} sample application */ public static IotpDevice quickstart(Topology topology, String deviceId) { Properties options = new Properties(); diff --git a/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java b/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java index 22f2f4c1..4cde14c2 100644 --- a/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java +++ b/connectors/mqtt/src/test/java/org/apache/edgent/test/connectors/mqtt/MqttOpenTest.java @@ -32,7 +32,7 @@ Licensed to the Apache Software Foundation (ASF) under one /** * Uses the MQTT test broker at: tcp://test.mosquitto.org:1883 * - * @see http://test.mosquitto.org/ + * See http://test.mosquitto.org/ * * The tests are skipped if unable to connect (e.g., due to firewall config, * or the public broker not available for whatever reason). 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 368d00eb..4ebdcca2 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 @@ -64,8 +64,8 @@ Licensed to the Apache Software Foundation (ASF) under one * class MyApp { * ... * public void run(String[] args) throws Exception { - * IotProvider provider = new IotProvider((top) -> new IotpDevice(top, myDeviceConfig)); - * provider.registerTopology("app1", (iotDevice, cfg) -> buildApp1(iotDevice, cfg)); + * IotProvider provider = new IotProvider((top) -> new IotpDevice(top, myDeviceConfig)); + * provider.registerTopology("app1", (iotDevice, cfg) -> buildApp1(iotDevice, cfg)); * provider.start(); * } * private void buildApp1(IotDevice iotDevice, JsonConfig cfg) { diff --git a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java index 55569cef..e0676786 100644 --- a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java +++ b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScope.java @@ -50,7 +50,7 @@ Licensed to the Apache Software Foundation (ASF) under one * and {@link StreamScopeRegistryMXBean} runtime ControlService. *

* @see StreamScopeRegistry - * @see org.apache.edgent.providers.development.DevelopmentProvider DevelopmentProvider + * See {@code org.apache.edgent.providers.development.DevelopmentProvider} * * @param Tuple type */ diff --git a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java index e619708e..6a713258 100644 --- a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java +++ b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/StreamScopeRegistry.java @@ -37,7 +37,7 @@ Licensed to the Apache Software Foundation (ASF) under one * Static methods are provided for composing these names and extracting * the alias/identifier from generated names. *

- * @see org.apache.edgent.providers.development.DevelopmentProvider DevelopmentProvider + * See {@code org.apache.edgent.providers.development.DevelopmentProvider} */ public class StreamScopeRegistry { private final Map> byNameMap = new HashMap<>(); diff --git a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java index 26372595..2f1d6a21 100644 --- a/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java +++ b/utils/streamscope/src/main/java/org/apache/edgent/streamscope/mbeans/StreamScopeRegistryMXBean.java @@ -24,7 +24,7 @@ Licensed to the Apache Software Foundation (ASF) under one * The registry contains a collection of StreamScopeMXBean instances * that are registered by a stream identifier. *

- * @see org.apache.edgent.providers.development.DevelopmentProvider DevelopmentProvider + * See {@code org.apache.edgent.providers.development.DevelopmentProvider} */ public interface StreamScopeRegistryMXBean {