This is an automated email from the ASF dual-hosted git repository.
penghui pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 692a28e Fix JavaDoc issues. Spotted by IntelliJ (#8054)
692a28e is described below
commit 692a28e9473f230a07329dabe0392e16c9f7a2ab
Author: Frank J Kelly <[email protected]>
AuthorDate: Tue Sep 29 23:35:32 2020 -0400
Fix JavaDoc issues. Spotted by IntelliJ (#8054)
Issues spotted by IntelliJ
### Motivation
IntelliJ complains and highlights these issues
### Modifications
Sync JavaDoc with code
### Verifying this change
This change is a trivial rework / code cleanup without any test coverage.
---
.../apache/bookkeeper/test/BookKeeperClusterTestCase.java | 4 +---
.../common/configuration/PulsarConfigurationLoader.java | 2 +-
.../pulsar/broker/loadbalance/impl/BundleSplitterTask.java | 2 --
.../org/apache/pulsar/broker/namespace/NamespaceService.java | 4 +---
.../java/org/apache/pulsar/broker/namespace/OwnedBundle.java | 5 ++---
.../org/apache/pulsar/broker/namespace/OwnershipCache.java | 12 ++++++------
.../apache/pulsar/broker/namespace/ServiceUnitZkUtils.java | 4 ++--
.../org/apache/pulsar/broker/admin/v1/V1_AdminApiTest2.java | 1 -
.../api/AuthenticationTlsHostnameVerificationTest.java | 2 +-
.../pulsar/client/api/MessageDispatchThrottlingTest.java | 2 --
.../org/apache/pulsar/client/api/NonPersistentTopicTest.java | 1 -
.../org/apache/pulsar/client/api/ClientConfiguration.java | 2 +-
.../org/apache/pulsar/client/api/ConsumerConfiguration.java | 2 +-
.../src/main/java/org/apache/pulsar/client/admin/Topics.java | 4 ++--
.../apache/pulsar/discovery/service/DiscoveryService.java | 3 +--
.../pulsar/discovery/service/DiscoveryServiceTest.java | 3 ++-
.../src/main/java/org/apache/pulsar/io/kinesis/Utils.java | 4 +---
.../org/apache/pulsar/storm/PulsarSpoutConfiguration.java | 2 +-
.../java/org/apache/pulsar/storm/PulsarSpoutConsumer.java | 2 +-
.../java/org/apache/pulsar/storm/SharedPulsarClient.java | 1 -
.../java/org/apache/pulsar/zookeeper/ZooKeeperCache.java | 2 --
.../org/apache/pulsar/zookeeper/ZooKeeperClientFactory.java | 4 +++-
site2/docs/security-extending.md | 2 +-
23 files changed, 28 insertions(+), 42 deletions(-)
diff --git
a/managed-ledger/src/test/java/org/apache/bookkeeper/test/BookKeeperClusterTestCase.java
b/managed-ledger/src/test/java/org/apache/bookkeeper/test/BookKeeperClusterTestCase.java
index 96aaff8..f030eae 100644
---
a/managed-ledger/src/test/java/org/apache/bookkeeper/test/BookKeeperClusterTestCase.java
+++
b/managed-ledger/src/test/java/org/apache/bookkeeper/test/BookKeeperClusterTestCase.java
@@ -343,7 +343,7 @@ public abstract class BookKeeperClusterTestCase {
*
* @param addr
* Socket Address
- * @param latch
+ * @param l
* Latch to wait on
* @throws InterruptedException
* @throws IOException
@@ -417,8 +417,6 @@ public abstract class BookKeeperClusterTestCase {
* Helper method to startup a new bookie server with the indicated port
number. Also, starts the auto recovery
* process, if the isAutoRecoveryEnabled is set true.
*
- * @param port
- * Port to start the new bookie server on
* @throws IOException
*/
public int startNewBookie() throws Exception {
diff --git
a/pulsar-broker-common/src/main/java/org/apache/pulsar/common/configuration/PulsarConfigurationLoader.java
b/pulsar-broker-common/src/main/java/org/apache/pulsar/common/configuration/PulsarConfigurationLoader.java
index 4db3e25..1bf7101 100644
---
a/pulsar-broker-common/src/main/java/org/apache/pulsar/common/configuration/PulsarConfigurationLoader.java
+++
b/pulsar-broker-common/src/main/java/org/apache/pulsar/common/configuration/PulsarConfigurationLoader.java
@@ -106,7 +106,7 @@ public class PulsarConfigurationLoader {
* and value of the element is null or number value is not in a provided
(min,max) range then consider as incomplete
* object and throws exception with incomplete parameters
*
- * @param object
+ * @param obj
* @return
* @throws IllegalArgumentException
* if object is field values are not completed according to
{@link FieldContext} constraints.
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/BundleSplitterTask.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/BundleSplitterTask.java
index d15ece0..32d8526 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/BundleSplitterTask.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/BundleSplitterTask.java
@@ -57,8 +57,6 @@ public class BundleSplitterTask implements
BundleSplitStrategy {
* @param loadData
* Load data to base decisions on (does not have benefit of
preallocated data since this may not be the
* leader broker).
- * @param localData
- * Local data for the broker we are splitting on.
* @param pulsar
* Service to use.
* @return All bundles who have exceeded configured thresholds in number
of topics, number of sessions, total
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/NamespaceService.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/NamespaceService.java
index a9df04c..c00e802 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/NamespaceService.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/NamespaceService.java
@@ -325,9 +325,7 @@ public class NamespaceService {
* Main internal method to lookup and setup ownership of service unit to a
broker
*
* @param bundle
- * @param authoritative
- * @param readOnly
- * @param advertisedListenerName
+ * @param options
* @return
* @throws PulsarServerException
*/
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnedBundle.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnedBundle.java
index 58eebb4..8a43f61 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnedBundle.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnedBundle.java
@@ -50,7 +50,7 @@ public class OwnedBundle {
/**
* constructor
*
- * @param nsname
+ * @param suName
*/
public OwnedBundle(NamespaceBundle suName) {
this.bundle = suName;
@@ -60,8 +60,7 @@ public class OwnedBundle {
/**
* Constructor to allow set initial active flag
*
- * @param nsname
- * @param nssvc
+ * @param suName
* @param active
*/
public OwnedBundle(NamespaceBundle suName, boolean active) {
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnershipCache.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnershipCache.java
index 18ba9e2..640a24a 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnershipCache.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/OwnershipCache.java
@@ -220,14 +220,14 @@ public class OwnershipCache {
/**
* Method to get the current owner of the <code>ServiceUnit</code>
*
- * @param suId
- * identifier of the <code>ServiceUnit</code>
+ * @param suName
+ * name of the <code>ServiceUnit</code>
* @return The ephemeral node data showing the current ownership info in
<code>ZooKeeper</code>
* @throws Exception
* throws exception if no ownership info is found
*/
- public CompletableFuture<Optional<NamespaceEphemeralData>>
getOwnerAsync(NamespaceBundle suname) {
- String path = ServiceUnitZkUtils.path(suname);
+ public CompletableFuture<Optional<NamespaceEphemeralData>>
getOwnerAsync(NamespaceBundle suName) {
+ String path = ServiceUnitZkUtils.path(suName);
CompletableFuture<OwnedBundle> ownedBundleFuture =
ownedBundlesCache.getIfPresent(path);
if (ownedBundleFuture != null) {
@@ -245,8 +245,8 @@ public class OwnershipCache {
/**
* Method to get the current owner of the <code>ServiceUnit</code> or set
the local broker as the owner if absent
*
- * @param suId
- * identifier of the <code>NamespaceBundle</code>
+ * @param bundle
+ * the <code>NamespaceBundle</code>
* @return The ephemeral node data showing the current ownership info in
<code>ZooKeeper</code>
* @throws Exception
*/
diff --git
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/ServiceUnitZkUtils.java
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/ServiceUnitZkUtils.java
index 2967236..2760938 100644
---
a/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/ServiceUnitZkUtils.java
+++
b/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/ServiceUnitZkUtils.java
@@ -178,8 +178,8 @@ public final class ServiceUnitZkUtils {
*
* @param zkc
* the <code>ZooKeeper</code> connected session object
- * @param nsname
- * the name space name
+ * @param path
+ * the namespace path
* @param value
* the broker url that serves the name space.
* @return
diff --git
a/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/v1/V1_AdminApiTest2.java
b/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/v1/V1_AdminApiTest2.java
index 360346f..e0835ff 100644
---
a/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/v1/V1_AdminApiTest2.java
+++
b/pulsar-broker/src/test/java/org/apache/pulsar/broker/admin/v1/V1_AdminApiTest2.java
@@ -128,7 +128,6 @@ public class V1_AdminApiTest2 extends
MockedPulsarServiceBaseTest {
*
* </pre>
*
- * @param topicName
* @throws Exception
*/
@Test
diff --git
a/pulsar-broker/src/test/java/org/apache/pulsar/client/api/AuthenticationTlsHostnameVerificationTest.java
b/pulsar-broker/src/test/java/org/apache/pulsar/client/api/AuthenticationTlsHostnameVerificationTest.java
index b3df4f9..610ac83 100644
---
a/pulsar-broker/src/test/java/org/apache/pulsar/client/api/AuthenticationTlsHostnameVerificationTest.java
+++
b/pulsar-broker/src/test/java/org/apache/pulsar/client/api/AuthenticationTlsHostnameVerificationTest.java
@@ -231,7 +231,7 @@ public class AuthenticationTlsHostnameVerificationTest
extends ProducerConsumerB
}
/**
- * This test verifies {@link DefaultHostnameVerifier} behavior and gives
fair idea about host matching result
+ * This test verifies {@link TlsHostnameVerifier} behavior and gives fair
idea about host matching result
*
* @throws Exception
*/
diff --git
a/pulsar-broker/src/test/java/org/apache/pulsar/client/api/MessageDispatchThrottlingTest.java
b/pulsar-broker/src/test/java/org/apache/pulsar/client/api/MessageDispatchThrottlingTest.java
index 2373029..d74f9bf 100644
---
a/pulsar-broker/src/test/java/org/apache/pulsar/client/api/MessageDispatchThrottlingTest.java
+++
b/pulsar-broker/src/test/java/org/apache/pulsar/client/api/MessageDispatchThrottlingTest.java
@@ -243,8 +243,6 @@ public class MessageDispatchThrottlingTest extends
ProducerConsumerBase {
/**
* It verifies that dispatch-rate throttling with cluster-configuration
*
- * @param subscription
- * @param dispatchRateType
* @throws Exception
*/
@Test()
diff --git
a/pulsar-broker/src/test/java/org/apache/pulsar/client/api/NonPersistentTopicTest.java
b/pulsar-broker/src/test/java/org/apache/pulsar/client/api/NonPersistentTopicTest.java
index 49ee0a7..3a951fc 100644
---
a/pulsar-broker/src/test/java/org/apache/pulsar/client/api/NonPersistentTopicTest.java
+++
b/pulsar-broker/src/test/java/org/apache/pulsar/client/api/NonPersistentTopicTest.java
@@ -680,7 +680,6 @@ public class NonPersistentTopicTest extends
ProducerConsumerBase {
/**
* verifies: broker should reject non-persistent topic loading if broker
is not enable for non-persistent topic
*
- * @param loadManagerName
* @throws Exception
*/
@Test
diff --git
a/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ClientConfiguration.java
b/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ClientConfiguration.java
index e5bac91..b2bdf41 100644
---
a/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ClientConfiguration.java
+++
b/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ClientConfiguration.java
@@ -291,7 +291,7 @@ public class ClientConfiguration implements Serializable {
* Set the interval between each stat info <i>(default: 60 seconds)</i>
Stats will be activated with positive
* statsIntervalSeconds It should be set to at least 1 second
*
- * @param statsIntervalSeconds
+ * @param statsInterval
* the interval between each stat info
* @param unit
* time unit for {@code statsInterval}
diff --git
a/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ConsumerConfiguration.java
b/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ConsumerConfiguration.java
index ec7e397..af3242c 100644
---
a/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ConsumerConfiguration.java
+++
b/pulsar-client-1x-base/pulsar-client-1x/src/main/java/org/apache/pulsar/client/api/ConsumerConfiguration.java
@@ -372,7 +372,7 @@ public class ConsumerConfiguration implements Serializable {
}
/**
- * @return the configured {@link subscriptionInitailPosition} for the
consumer
+ * @return the configured {@link subscriptionInitialPosition} for the
consumer
*/
public SubscriptionInitialPosition getSubscriptionInitialPosition(){
return conf.getSubscriptionInitialPosition();
diff --git
a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Topics.java
b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Topics.java
index e039083..18ec1db 100644
---
a/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Topics.java
+++
b/pulsar-client-admin/src/main/java/org/apache/pulsar/client/admin/Topics.java
@@ -1730,7 +1730,7 @@ public interface Topics {
/**
* set inactive topic policies of a topic.
* @param topic
- * @param maxNum
+ * @param inactiveTopicPolicies
* @throws PulsarAdminException
*/
void setInactiveTopicPolicies(String topic
@@ -1739,7 +1739,7 @@ public interface Topics {
/**
* set inactive topic policies of a topic asynchronously.
* @param topic
- * @param maxNum
+ * @param inactiveTopicPolicies
* @return
*/
CompletableFuture<Void> setInactiveTopicPoliciesAsync(String topic,
InactiveTopicPolicies inactiveTopicPolicies);
diff --git
a/pulsar-discovery-service/src/main/java/org/apache/pulsar/discovery/service/DiscoveryService.java
b/pulsar-discovery-service/src/main/java/org/apache/pulsar/discovery/service/DiscoveryService.java
index f0ed571..587cbd2 100644
---
a/pulsar-discovery-service/src/main/java/org/apache/pulsar/discovery/service/DiscoveryService.java
+++
b/pulsar-discovery-service/src/main/java/org/apache/pulsar/discovery/service/DiscoveryService.java
@@ -155,8 +155,7 @@ public class DiscoveryService implements Closeable {
/**
* Derive the host
*
- * @param isBindOnLocalhost
- * @return
+ * @return String containing the hostname
*/
public String host() {
try {
diff --git
a/pulsar-discovery-service/src/test/java/org/apache/pulsar/discovery/service/DiscoveryServiceTest.java
b/pulsar-discovery-service/src/test/java/org/apache/pulsar/discovery/service/DiscoveryServiceTest.java
index b7ab036..b30c66d 100644
---
a/pulsar-discovery-service/src/test/java/org/apache/pulsar/discovery/service/DiscoveryServiceTest.java
+++
b/pulsar-discovery-service/src/test/java/org/apache/pulsar/discovery/service/DiscoveryServiceTest.java
@@ -151,7 +151,8 @@ public class DiscoveryServiceTest extends
BaseDiscoveryTestSetup {
* creates ClientHandler channel to connect and communicate with server
*
* @param serviceUrl
- * @param latch
+ * @param promise
+ * @param tls
* @return
* @throws URISyntaxException
*/
diff --git
a/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/Utils.java
b/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/Utils.java
index 47f9222..b8ab92e 100644
--- a/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/Utils.java
+++ b/pulsar-io/kinesis/src/main/java/org/apache/pulsar/io/kinesis/Utils.java
@@ -58,7 +58,6 @@ public class Utils {
* Serialize record to flat-buffer. it's not a thread-safe method.
*
* @param record
- * @param data
* @return
*/
public static ByteBuffer serializeRecordToFlatBuffer(Record<byte[]>
record) {
@@ -167,8 +166,7 @@ public class Utils {
* Serializes sink-record into json format. It encodes encryption-keys,
encryption-param and payload in base64
* format so, it can be sent in json.
*
- * @param inputRecordContext
- * @param data
+ * @param record
* @return
*/
public static String serializeRecordToJson(Record<byte[]> record) {
diff --git
a/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConfiguration.java
b/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConfiguration.java
index 0ef7686..db797ee 100644
---
a/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConfiguration.java
+++
b/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConfiguration.java
@@ -174,7 +174,7 @@ public class PulsarSpoutConfiguration extends
PulsarStormConfiguration {
* if subscription is not durable then it creates non-durable reader to
start reading from the
* {@link #setNonDurableSubscriptionReadPosition(MessagePosition)} in
topic.
*
- * @param nonDurableSubscription
+ * @param durableSubscription
*/
public void setDurableSubscription(boolean durableSubscription) {
this.durableSubscription = durableSubscription;
diff --git
a/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConsumer.java
b/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConsumer.java
index d845c4e..5502a62 100644
---
a/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConsumer.java
+++
b/pulsar-storm/src/main/java/org/apache/pulsar/storm/PulsarSpoutConsumer.java
@@ -29,7 +29,7 @@ public interface PulsarSpoutConsumer {
* Receives a single message.
*
* @param waitTime
- * @param milliseconds
+ * @param unit
* @return
* @throws PulsarClientException
*/
diff --git
a/pulsar-storm/src/main/java/org/apache/pulsar/storm/SharedPulsarClient.java
b/pulsar-storm/src/main/java/org/apache/pulsar/storm/SharedPulsarClient.java
index b8263a4..f4950c6 100644
--- a/pulsar-storm/src/main/java/org/apache/pulsar/storm/SharedPulsarClient.java
+++ b/pulsar-storm/src/main/java/org/apache/pulsar/storm/SharedPulsarClient.java
@@ -60,7 +60,6 @@ public class SharedPulsarClient {
*
* @param componentId
* the id of the spout/bolt
- * @param serviceUrl
* @param clientConf
* @return
* @throws PulsarClientException
diff --git
a/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperCache.java
b/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperCache.java
index 7085a8b..23652af 100644
---
a/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperCache.java
+++
b/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperCache.java
@@ -261,7 +261,6 @@ public abstract class ZooKeeperCache implements Watcher {
*
* @param path
* @param deserializer
- * @param stat
* @return
* @throws Exception
*/
@@ -314,7 +313,6 @@ public abstract class ZooKeeperCache implements Watcher {
* @param path
* @param watcher
* @param deserializer
- * @param stat
* @return
* @throws Exception
*/
diff --git
a/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperClientFactory.java
b/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperClientFactory.java
index f8d35e0..6da4539 100644
---
a/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperClientFactory.java
+++
b/pulsar-zookeeper-utils/src/main/java/org/apache/pulsar/zookeeper/ZooKeeperClientFactory.java
@@ -39,7 +39,9 @@ public interface ZooKeeperClientFactory {
/**
* Return a future yielding a connected ZooKeeper client
*
- * @param conf
+ * @param serverList
+ * @param sessionType
+ * @param zkSessionTimeoutMillis
* @return
*/
CompletableFuture<ZooKeeper> create(String serverList, SessionType
sessionType, int zkSessionTimeoutMillis);
diff --git a/site2/docs/security-extending.md b/site2/docs/security-extending.md
index 716e4b0..d7e5d90 100644
--- a/site2/docs/security-extending.md
+++ b/site2/docs/security-extending.md
@@ -112,7 +112,7 @@ public interface AuthorizationProvider extends Closeable {
/**
* Perform initialization for the authorization provider
*
- * @param config
+ * @param conf
* broker config object
* @param configCache
* pulsar zk configuration cache service
