You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@storm.apache.org by rz...@apache.org on 2023/08/25 08:04:30 UTC
[storm] 06/06: STORM-3932 - Fix errors/warnings found while generating javadoc in storm-client
This is an automated email from the ASF dual-hosted git repository.
rzo1 pushed a commit to branch javdoc-fixes
in repository https://gitbox.apache.org/repos/asf/storm.git
commit 739ef15d4611c0024b7d1bf1745b53174e561397
Author: Richard Zowalla <ri...@hs-heilbronn.de>
AuthorDate: Fri Aug 25 10:03:53 2023 +0200
STORM-3932 - Fix errors/warnings found while generating javadoc in storm-client
---
storm-client/src/jvm/org/apache/storm/Config.java | 26 +++++++++++-----------
.../src/jvm/org/apache/storm/ILocalCluster.java | 4 ++--
.../jvm/org/apache/storm/blobstore/BlobStore.java | 1 -
.../org/apache/storm/cluster/IStateStorage.java | 1 -
.../apache/storm/cluster/IStormClusterState.java | 26 +++++++++++-----------
.../jvm/org/apache/storm/metric/api/IMetric.java | 9 ++++----
.../src/jvm/org/apache/storm/streams/Pair.java | 3 ---
.../jvm/org/apache/storm/streams/PairStream.java | 20 -----------------
.../org/apache/storm/streams/StreamBuilder.java | 6 -----
.../streams/operations/CombinerAggregator.java | 6 -----
.../storm/streams/operations/StateUpdater.java | 5 -----
.../org/apache/storm/topology/TopologyBuilder.java | 3 +--
.../src/jvm/org/apache/storm/trident/Stream.java | 2 --
.../storm/trident/operation/ITridentResource.java | 3 +--
.../apache/storm/utils/DefaultShellLogHandler.java | 2 --
.../src/jvm/org/apache/storm/utils/Utils.java | 1 -
.../jvm/org/apache/storm/utils/VersionedStore.java | 2 +-
17 files changed, 36 insertions(+), 84 deletions(-)
diff --git a/storm-client/src/jvm/org/apache/storm/Config.java b/storm-client/src/jvm/org/apache/storm/Config.java
index 93973fcc6..7837cf5ef 100644
--- a/storm-client/src/jvm/org/apache/storm/Config.java
+++ b/storm-client/src/jvm/org/apache/storm/Config.java
@@ -131,10 +131,9 @@ public class Config extends HashMap<String, Object> {
public static final String TASK_CREDENTIALS_POLL_SECS = "task.credentials.poll.secs";
/**
* Whether to enable backpressure in for a certain topology.
- *
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
@IsBoolean
public static final String TOPOLOGY_BACKPRESSURE_ENABLE = "topology.backpressure.enable";
/**
@@ -860,16 +859,17 @@ public class Config extends HashMap<String, Object> {
public static final String STORM_DO_AS_USER = "storm.doAsUser";
/**
* The maximum number of machines that should be used by this topology. This configuration can
- * be used to isolate topologies from each other. See {@link org.apache.storm.scheduler.multitenant.MultitenantScheduler}.
+ * be used to isolate topologies from each other. See {@code org.apache.storm.scheduler.multitenant.MultitenantScheduler}.
* Round Robin Strategy uses this value to avoid spreading a topology too
- * thinly over a large number of machines - avoiding the the extreme case where the topology would be spread over
+ * thinly over a large number of machines - avoiding the extreme case where the topology would be spread over
* all workers and thus deny scheduling of other topologies. Round Robin scheduling will occupy all the workers on
* this limited number of machines, forcing other topologies to be scheduled on other machines; thus isolating the
* topology from other topologies.
- * Set storm.scheduler to {@link org.apache.storm.scheduler.multitenant.MultitenantScheduler}
- * Alternatively set storm.scheduler to {@link org.apache.storm.scheduler.resource.ResourceAwareScheduler}
- * using {@link #TOPOLOGY_SCHEDULER_STRATEGY} set to
- * {@link org.apache.storm.scheduler.resource.strategies.scheduling.RoundRobinResourceAwareStrategy} */
+ * Set {@code storm.scheduler} to {@code org.apache.storm.scheduler.multitenant.MultitenantScheduler}
+ * Alternatively set {@code storm.scheduler} to {@code org.apache.storm.scheduler.resource.ResourceAwareScheduler}
+ * using {@link Config#TOPOLOGY_SCHEDULER_STRATEGY} set to
+ * {@code org.apache.storm.scheduler.resource.strategies.scheduling.RoundRobinResourceAwareStrategy}
+ * */
@IsInteger
@IsPositiveNumber
public static final String TOPOLOGY_ISOLATED_MACHINES = "topology.isolate.machines";
@@ -1237,9 +1237,9 @@ public class Config extends HashMap<String, Object> {
/**
* Configure the topology metrics reporters to be used on workers.
- * @deprecated Use {@link Config#TOPOLOGY_METRICS_REPORTERS} instead.
+ * Use {@link Config#TOPOLOGY_METRICS_REPORTERS} instead.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
@IsListEntryCustom(entryValidatorClasses = { MetricReportersValidator.class })
public static final String STORM_METRICS_REPORTERS = "storm.metrics.reporters";
@@ -1268,9 +1268,9 @@ public class Config extends HashMap<String, Object> {
* If the instance field of the principal is the string "_HOST", it will
* be replaced with the host name of the server the daemon is running on
* (by calling {@link #getBlobstoreHDFSPrincipal(Map conf)} method).
- * @Deprecated Use {@link Config#STORM_HDFS_LOGIN_PRINCIPAL} instead.
+ * Note: Use {@link Config#STORM_HDFS_LOGIN_PRINCIPAL} instead.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
@IsString
public static final String BLOBSTORE_HDFS_PRINCIPAL = "blobstore.hdfs.principal";
/**
diff --git a/storm-client/src/jvm/org/apache/storm/ILocalCluster.java b/storm-client/src/jvm/org/apache/storm/ILocalCluster.java
index 687be64df..8e7cfa8f4 100644
--- a/storm-client/src/jvm/org/apache/storm/ILocalCluster.java
+++ b/storm-client/src/jvm/org/apache/storm/ILocalCluster.java
@@ -79,7 +79,7 @@ public interface ILocalCluster extends AutoCloseable {
* @param options for how to kill the topology
* @throws TException on any error from nimbus
*/
- void killTopologyWithOpts(String name, KillOptions options) throws TException;
+ void killTopologyWithOpts(String topologyName, KillOptions options) throws TException;
/**
* Activate a topology.
@@ -203,7 +203,7 @@ public interface ILocalCluster extends AutoCloseable {
* @param secs the number of seconds to advance time
* @param steps the number of steps we should take when advancing simulated time
*/
- void advanceClusterTime(int secs, int step) throws InterruptedException;
+ void advanceClusterTime(int secs, int steps) throws InterruptedException;
/**
* If the cluster is tracked get the id for the tracked cluster. This is intended for internal testing only.
diff --git a/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java b/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java
index 5f415843f..8323884ae 100644
--- a/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java
+++ b/storm-client/src/jvm/org/apache/storm/blobstore/BlobStore.java
@@ -256,7 +256,6 @@ public abstract class BlobStore implements Shutdownable, AutoCloseable {
* Filters keys based on the KeyFilter passed as the argument.
*
* @param filter KeyFilter
- * @param <R> Type
* @return Set of filtered keys
*/
public <R> Set<R> filterAndListKeys(KeyFilter<R> filter) {
diff --git a/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java b/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java
index d0b45af42..61b4c82d3 100644
--- a/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java
+++ b/storm-client/src/jvm/org/apache/storm/cluster/IStateStorage.java
@@ -64,7 +64,6 @@ public interface IStateStorage extends Closeable {
*
* @param path The path to create, along with all its parents.
* @param acls The acls to apply to the path. May be null.
- * @return path
*/
void mkdirs(String path, List<ACL> acls);
diff --git a/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java b/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java
index 412c76170..961625abd 100644
--- a/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java
+++ b/storm-client/src/jvm/org/apache/storm/cluster/IStormClusterState.java
@@ -61,14 +61,14 @@ public interface IStormClusterState {
Map<String, Assignment> assignmentsInfo();
/**
- * Sync the remote state store assignments to local backend, used when master gains leadership, see {@link LeaderListenerCallback}.
+ * Sync the remote state store assignments to local backend, used when master gains leadership, see {@code org.apache.storm.nimbus.LeaderListenerCallback}.
*
* @param remote assigned assignments for a specific {@link IStormClusterState} instance, usually a supervisor/node.
*/
void syncRemoteAssignments(Map<String, byte[]> remote);
/**
- * Flag to indicate if the assignments synced successfully, see {@link #syncRemoteAssignments(Map)}.
+ * Flag to indicate if the assignments synced successfully, see {@link IStormClusterState#syncRemoteAssignments(Map)}.
*
* @return true if is synced successfully
*/
@@ -82,7 +82,7 @@ public interface IStormClusterState {
boolean isPacemakerStateStore();
/**
- * Mark the assignments as synced successfully, see {@link #isAssignmentsBackendSynchronized()}.
+ * Mark the assignments as synced successfully, see {@link IStormClusterState#isAssignmentsBackendSynchronized()}.
*/
void setAssignmentsBackendSynchronized();
@@ -150,9 +150,9 @@ public interface IStormClusterState {
/**
* Get backpressure topologies.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
List<String> backpressureTopologies();
/**
@@ -178,30 +178,30 @@ public interface IStormClusterState {
/**
* Get topoloy backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
boolean topologyBackpressure(String stormId, long timeoutMs, Runnable callback);
/**
* Setup backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
void setupBackpressure(String stormId, Map<String, Object> topoConf);
/**
* Remove backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
void removeBackpressure(String stormId);
/**
* Remove worker backpressure.
- * @deprecated: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
+ * Note: In Storm 2.0. Retained for enabling transition from 1.x. Will be removed soon.
*/
- @Deprecated
+ @Deprecated(forRemoval = true, since = "2.0.0")
void removeWorkerBackpressure(String stormId, String node, Long port);
void activateStorm(String stormId, StormBase stormBase, Map<String, Object> topoConf);
diff --git a/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java b/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java
index b6670fcb2..6a306eda9 100644
--- a/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java
+++ b/storm-client/src/jvm/org/apache/storm/metric/api/IMetric.java
@@ -12,16 +12,17 @@
package org.apache.storm.metric.api;
+import java.util.Collection;
+
/**
* Produces metrics.
*/
public interface IMetric {
/**
* Get value and reset.
- * @return an object that will be sent sent to {@link IMetricsConsumer#handleDataPoints(org.apache.storm.metric.api.IMetricsConsumer
- * .TaskInfo,
- * java.util.Collection)}. If null is returned nothing will be sent. If this value can be reset, like with a counter, a side effect
- * of calling this should be that the value is reset.
+ * @return an object that will be sent to {@link IMetricsConsumer#handleDataPoints(IMetricsConsumer.TaskInfo, Collection)}.
+ * If {@code null} is returned nothing will be sent. If this value can be reset, like with a counter, a side effect
+ * of calling this should be that the value is reset.
*/
Object getValueAndReset();
}
diff --git a/storm-client/src/jvm/org/apache/storm/streams/Pair.java b/storm-client/src/jvm/org/apache/storm/streams/Pair.java
index ea065a4bb..bd513ac1e 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/Pair.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/Pair.java
@@ -16,9 +16,6 @@ import java.io.Serializable;
/**
* A pair of values.
- *
- * @param <T1> the type of the first value
- * @param <T2> the type of the second value
*/
public final class Pair<T1, T2> implements Serializable {
/**
diff --git a/storm-client/src/jvm/org/apache/storm/streams/PairStream.java b/storm-client/src/jvm/org/apache/storm/streams/PairStream.java
index 14b88a05c..d2305564d 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/PairStream.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/PairStream.java
@@ -59,7 +59,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* Returns a new stream by applying a {@link Function} to the value of each key-value pairs in this stream.
*
* @param function the mapping function
- * @param <R> the result type
* @return the new stream
*/
public <R> PairStream<K, R> mapValues(Function<? super V, ? extends R> function) {
@@ -71,7 +70,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* Return a new stream by applying a {@link FlatMapFunction} function to the value of each key-value pairs in this stream.
*
* @param function the flatmap function
- * @param <R> the result type
* @return the new stream
*/
public <R> PairStream<K, R> flatMapValues(FlatMapFunction<? super V, ? extends R> function) {
@@ -85,7 +83,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* @param initialValue the initial value of the result
* @param accumulator the accumulator
* @param combiner the combiner
- * @param <R> the result type
* @return the new stream
*/
public <R> PairStream<K, R> aggregateByKey(R initialValue,
@@ -98,8 +95,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* Aggregates the values for each key of this stream using the given {@link CombinerAggregator}.
*
* @param aggregator the combiner aggregator
- * @param <A> the accumulator type
- * @param <R> the result type
* @return the new stream
*/
public <A, R> PairStream<K, R> aggregateByKey(CombinerAggregator<? super V, A, ? extends R> aggregator) {
@@ -180,7 +175,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> join(PairStream<K, V1> otherStream) {
@@ -195,8 +189,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> join(PairStream<K, V1> otherStream,
@@ -216,7 +208,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> leftOuterJoin(PairStream<K, V1> otherStream) {
@@ -231,8 +222,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> leftOuterJoin(PairStream<K, V1> otherStream,
@@ -252,7 +241,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> rightOuterJoin(PairStream<K, V1> otherStream) {
@@ -267,8 +255,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> rightOuterJoin(PairStream<K, V1> otherStream,
@@ -288,7 +274,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<V, V1>> fullOuterJoin(PairStream<K, V1> otherStream) {
@@ -303,8 +288,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
*
* @param otherStream the other stream
* @param valueJoiner the {@link ValueJoiner}
- * @param <R> the type of the values resulting from the join
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <R, V1> PairStream<K, R> fullOuterJoin(PairStream<K, V1> otherStream,
@@ -352,7 +335,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* choose the state implementation.
*
* @param stateUpdateFn the state update function
- * @param <R> the result type
* @return the {@link StreamState} which can be used to query the state
*/
public <R> StreamState<K, R> updateStateByKey(R initialValue,
@@ -366,7 +348,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* choose the state implementation.
*
* @param stateUpdater the state updater
- * @param <R> the result type
* @return the {@link StreamState} which can be used to query the state
*/
public <R> StreamState<K, R> updateStateByKey(StateUpdater<? super V, ? extends R> stateUpdater) {
@@ -385,7 +366,6 @@ public class PairStream<K, V> extends Stream<Pair<K, V>> {
* </p>
*
* @param otherStream the other stream
- * @param <V1> the type of the values in the other stream
* @return the new stream
*/
public <V1> PairStream<K, Pair<Iterable<V>, Iterable<V1>>> coGroupByKey(PairStream<K, V1> otherStream) {
diff --git a/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java b/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java
index 7827ada57..45ed897e8 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/StreamBuilder.java
@@ -103,7 +103,6 @@ public class StreamBuilder {
*
* @param spout the spout
* @param valueMapper the value mapper
- * @param <T> the type of values in the resultant stream
* @return the new stream
*/
public <T> Stream<T> newStream(IRichSpout spout, TupleValueMapper<T> valueMapper) {
@@ -118,7 +117,6 @@ public class StreamBuilder {
* @param spout the spout
* @param valueMapper the value mapper
* @param parallelism the parallelism of the stream
- * @param <T> the type of values in the resultant stream
* @return the new stream
*/
public <T> Stream<T> newStream(IRichSpout spout, TupleValueMapper<T> valueMapper, int parallelism) {
@@ -131,8 +129,6 @@ public class StreamBuilder {
*
* @param spout the spout
* @param pairValueMapper the pair value mapper
- * @param <K> the key type
- * @param <V> the value type
* @return the new stream of key-value pairs
*/
public <K, V> PairStream<K, V> newStream(IRichSpout spout, PairValueMapper<K, V> pairValueMapper) {
@@ -146,8 +142,6 @@ public class StreamBuilder {
* @param spout the spout
* @param pairValueMapper the pair value mapper
* @param parallelism the parallelism of the stream
- * @param <K> the key type
- * @param <V> the value type
* @return the new stream of key-value pairs
*/
public <K, V> PairStream<K, V> newStream(IRichSpout spout, PairValueMapper<K, V> pairValueMapper, int parallelism) {
diff --git a/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java b/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java
index 926fd7d86..bb36fbe67 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/operations/CombinerAggregator.java
@@ -14,10 +14,6 @@ package org.apache.storm.streams.operations;
/**
* Interface for aggregating values.
- *
- * @param <T> the original value type
- * @param <A> the accumulator type
- * @param <R> the result type
*/
public interface CombinerAggregator<T, A, R> extends Operation {
/**
@@ -26,8 +22,6 @@ public interface CombinerAggregator<T, A, R> extends Operation {
* @param initialValue the initial value of the result to start with
* @param accumulator a function that accumulates values into a partial result
* @param combiner a function that combines partially accumulated results
- * @param <T> the value type
- * @param <R> the result type
* @return the {@link CombinerAggregator}
*/
static <T, R> CombinerAggregator<T, R, R> of(R initialValue,
diff --git a/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java b/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java
index 7cc1601b2..bbdf08ef5 100644
--- a/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java
+++ b/storm-client/src/jvm/org/apache/storm/streams/operations/StateUpdater.java
@@ -14,9 +14,6 @@ package org.apache.storm.streams.operations;
/**
* Interface for updating state.
- *
- * @param <T> the value type
- * @param <S> the state type
*/
public interface StateUpdater<T, S> extends Operation {
/**
@@ -24,8 +21,6 @@ public interface StateUpdater<T, S> extends Operation {
*
* @param initialValue the intial value of the state
* @param stateUpdateFn the state update function
- * @param <T> the value type
- * @param <S> the state type
* @return the {@link StateUpdater}
*/
static <T, S> StateUpdater<T, S> of(S initialValue,
diff --git a/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java b/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java
index 0ef7afee0..309e7291e 100644
--- a/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java
+++ b/storm-client/src/jvm/org/apache/storm/topology/TopologyBuilder.java
@@ -330,8 +330,7 @@ public class TopologyBuilder {
* outputs.
* @param bolt the stateful windowed bolt
* @param parallelismHint the number of tasks that should be assigned to execute this bolt. Each task will run on a thread in a process
- * somwehere around the cluster.
- * @param <T> the type of the state (e.g. {@link org.apache.storm.state.KeyValueState})
+ * somewhere around the cluster.
* @return use the returned object to declare the inputs to this component
*
* @throws IllegalArgumentException if {@code parallelism_hint} is not positive
diff --git a/storm-client/src/jvm/org/apache/storm/trident/Stream.java b/storm-client/src/jvm/org/apache/storm/trident/Stream.java
index 3695d4669..d25053d3e 100644
--- a/storm-client/src/jvm/org/apache/storm/trident/Stream.java
+++ b/storm-client/src/jvm/org/apache/storm/trident/Stream.java
@@ -529,7 +529,6 @@ public class Stream implements IAggregatableStream, ResourceDeclarer<Stream> {
*
* @param inputFieldName input field name
* @param comparator comparator used in for finding minimum of two tuple values of {@code inputFieldName}.
- * @param <T> type of tuple's given input field value.
* @return the new stream with this operation.
*/
public <T> Stream minBy(String inputFieldName, Comparator<T> comparator) {
@@ -569,7 +568,6 @@ public class Stream implements IAggregatableStream, ResourceDeclarer<Stream> {
*
* @param inputFieldName input field name
* @param comparator comparator used in for finding maximum of two tuple values of {@code inputFieldName}.
- * @param <T> type of tuple's given input field value.
* @return the new stream with this operation.
*/
public <T> Stream maxBy(String inputFieldName, Comparator<T> comparator) {
diff --git a/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java b/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java
index 8fd17f49e..f6c1d7866 100644
--- a/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java
+++ b/storm-client/src/jvm/org/apache/storm/trident/operation/ITridentResource.java
@@ -18,8 +18,7 @@ import org.apache.storm.generated.SharedMemory;
/**
* This interface is implemented by various Trident classes in order to gather and propogate resources that have been set on them.
- *
- * @see ResourceDeclarer
+ * See {@link org.apache.storm.topology.ResourceDeclarer}
*/
public interface ITridentResource {
/**
diff --git a/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java b/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java
index f0f3c7a26..96df6ae0a 100644
--- a/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java
+++ b/storm-client/src/jvm/org/apache/storm/utils/DefaultShellLogHandler.java
@@ -45,7 +45,6 @@ public class DefaultShellLogHandler implements ShellLogHandler {
* @param ownerCls - the class which instantiated this ShellLogHandler.
* @param process - the current {@link ShellProcess}.
* @param context - the current {@link TopologyContext}.
- * @see {@link ShellLogHandler#setUpContext}
*/
@Override
public void setUpContext(final Class<?> ownerCls, final ShellProcess process,
@@ -60,7 +59,6 @@ public class DefaultShellLogHandler implements ShellLogHandler {
* Log the given message.
*
* @param shellMsg - the {@link ShellMsg} to log.
- * @see {@link ShellLogHandler#log}
*/
@Override
public void log(final ShellMsg shellMsg) {
diff --git a/storm-client/src/jvm/org/apache/storm/utils/Utils.java b/storm-client/src/jvm/org/apache/storm/utils/Utils.java
index 44072be5b..28472c64d 100644
--- a/storm-client/src/jvm/org/apache/storm/utils/Utils.java
+++ b/storm-client/src/jvm/org/apache/storm/utils/Utils.java
@@ -855,7 +855,6 @@ public class Utils {
*
* @param str the encoded string.
* @param clazz the thrift class we are expecting.
- * @param <T> The type of clazz
* @return the decoded object
*/
public static <T> T deserializeFromString(String str, Class<T> clazz) {
diff --git a/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java b/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java
index 08d09f867..c4fd33f26 100644
--- a/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java
+++ b/storm-client/src/jvm/org/apache/storm/utils/VersionedStore.java
@@ -28,7 +28,7 @@ public class VersionedStore {
/**
* Creates a store at the given path.
*
- * @param The path for the store
+ * @param path The path for the store
* @param createRootDir option to create the path directory
*/
public VersionedStore(String path, boolean createRootDir) throws IOException {