You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@pulsar.apache.org by GitBox <gi...@apache.org> on 2022/03/22 03:59:21 UTC

[GitHub] [pulsar] michaeljmarshall opened a new issue #14783: Clean up Javadoc Warnings

michaeljmarshall opened a new issue #14783:
URL: https://github.com/apache/pulsar/issues/14783


   When Pulsar builds in CI, I can see the below warnings printed out (https://github.com/apache/pulsar/runs/5622671591?check_suite_focus=true):
   
   ```
    28 warnings
   Warning:  Javadoc Warnings
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/BrokerData.java:30: warning - invalid usage of tag <
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/BrokerData.java:30: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/LoadManagerShared.java:536: warning - Tag @link: reference not found: ServiceConfiguration.loadBalancerBrokerMaxTopics
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/LoadManagerShared.java:417: warning - invalid usage of tag {@param namespaceName}
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/LoadManagerShared.java:536: warning - Tag @link: reference not found: ServiceConfiguration.loadBalancerBrokerMaxTopics
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/ThresholdShedder.java:42: warning - invalid usage of tag {@link LocalBrokerData#getMaxResourceUsageWithWeight)
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/UniformLoadShedder.java:41: warning - Tag @link: reference not found: ServiceConfiguration#loadBalancerMsgThroughputMultiplierDifferenceShedderThreshold()
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/WRRPlacementStrategy.java:50: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/namespace/NamespaceService.java:292: warning - @return tag cannot be used in method with void return type.
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/HashRangeAutoSplitStickyKeyConsumerSelector.java:37: warning - invalid usage of tag <
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/HashRangeAutoSplitStickyKeyConsumerSelector.java:37: warning - invalid usage of tag <
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/HashRangeAutoSplitStickyKeyConsumerSelector.java:40: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/HashRangeAutoSplitStickyKeyConsumerSelector.java:44: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/HashRangeAutoSplitStickyKeyConsumerSelector.java:44: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/HashRangeAutoSplitStickyKeyConsumerSelector.java:49: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/TopicPoliciesService.java:86: warning - invalid usage of tag <
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/TopicPoliciesService.java:86: warning - invalid usage of tag >
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/persistent/DispatchRateLimiter.java:349: warning - invalid usage of tag <
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/streamingdispatch/StreamingEntryReader.java:79: warning - invalid usage of tag &
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/streamingdispatch/StreamingEntryReader.java:79: warning - invalid usage of tag &
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/streamingdispatch/StreamingEntryReader.java:79: warning - invalid usage of tag &
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/streamingdispatch/StreamingEntryReader.java:79: warning - invalid usage of tag &
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/stats/prometheus/PrometheusMetricsGenerator.java:54: warning - invalid usage of tag {@link https://prometheus.io/docs/instrumenting/exposition_formats/
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/transaction/buffer/TransactionBuffer.java:39: warning - Tag @link: reference not found: #commitTxn(TxnID, long, long)
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/LoadManagerShared.java:536: warning - Tag @link: reference not found: ServiceConfiguration.loadBalancerBrokerMaxTopics
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/streamingdispatch/StreamingEntryReader.java:79: warning - invalid usage of tag &
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/service/streamingdispatch/StreamingEntryReader.java:79: warning - invalid usage of tag &
   Warning:  /pulsar/pulsar-broker/src/main/java/org/apache/pulsar/broker/loadbalance/impl/LoadManagerShared.java:536: warning - Tag @link: reference not found: ServiceConfiguration.loadBalancerBrokerMaxTopics
   ```
   
   If possible, it'd be great to resolve these warnings to clean up the build logs a little.


-- 
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.

To unsubscribe, e-mail: commits-unsubscribe@pulsar.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org