Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

javadoc: cleanup Javadoc doclint warnings #3078

Closed
barchetta opened this issue Jun 4, 2021 · 0 comments · Fixed by #3336
Closed

javadoc: cleanup Javadoc doclint warnings #3078

barchetta opened this issue Jun 4, 2021 · 0 comments · Fixed by #3336
Assignees
Labels
bug Something isn't working docs P3

Comments

@barchetta
Copy link
Member

Environment Details

  • Helidon Version: 2.3.1-SNAPSHOT
  • JDK version: 11

Problem Description

We have doclint errors in our javadocs (see below). Many of these are in messaging/connectors.

Steps to reproduce

  1. rm -rf target/site
  2. mvn site
[WARNING] Javadoc Warnings
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/microprofile/scheduling/src/main/java/io/helidon/microprofile/scheduling/Scheduled.java:95: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/microprofile/scheduling/src/main/java/io/helidon/microprofile/scheduling/Scheduled.java:189: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/common/configurable/src/main/java/io/helidon/common/configurable/ThreadPoolSupplier.java:299: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/common/configurable/src/main/java/io/helidon/common/configurable/ThreadPoolSupplier.java:344: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:243: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> payload(PAYLOAD payload) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:254: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, boolean value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:265: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, byte value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:276: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, short value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:287: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, int value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:298: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, long value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:309: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, float value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:320: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, double value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/connectors/jms/src/main/java/io/helidon/messaging/connectors/jms/JmsMessage.java:331: warning: no @return
[WARNING] public OutgoingJmsMessageBuilder<PAYLOAD> property(String name, String value) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:381: warning: no description for @param
[WARNING] * @param consumerSupplier
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:394: warning: no description for @param
[WARNING] * @param topics
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:407: warning: no description for @param
[WARNING] * @param topicPattern
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:421: warning: no description for @param
[WARNING] * @param scheduler
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:433: warning: no description for @param
[WARNING] * @param periodExecutions
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:445: warning: no description for @param
[WARNING] * @param pollTimeout
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:464: warning: no description for @param
[WARNING] * @param autoCommit
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:479: warning: no description for @param
[WARNING] * @param ackTimeout
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaPublisher.java:495: warning: no description for @param
[WARNING] * @param limitNoAck
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaSubscriber.java:203: warning: no description for @param
[WARNING] * @param producerSupplier
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaSubscriber.java:216: warning: no description for @param
[WARNING] * @param backpressure
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/messaging/kafka/src/main/java/io/helidon/messaging/connectors/kafka/KafkaSubscriber.java:229: warning: no description for @param
[WARNING] * @param topics
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/common/mapper/src/main/java/io/helidon/common/mapper/MapperManager.java:193: warning: no @param for priority
[WARNING] public <S, T> Builder addMapper(Mapper<S, T> mapper, Class<S> sourceType, Class<T> targetType, int priority) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/common/mapper/src/main/java/io/helidon/common/mapper/MapperManager.java:232: warning: no @param for priority
[WARNING] public <S, T> Builder addMapper(Mapper<S, T> mapper, GenericType<S> sourceType, GenericType<T> targetType, int priority) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/security/providers/idcs-mapper/src/main/java/io/helidon/security/providers/idcs/mapper/IdcsMtRoleMapperProvider.java:394: warning: empty <p> tag
[WARNING] * <p>
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/common/reactive/src/main/java/io/helidon/common/reactive/IoMulti.java:447: warning: no @return
[WARNING] public OutputStreamMultiBuilder timeout(long timeout, TimeUnit unit) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/common/reactive/src/main/java/io/helidon/common/reactive/IoMulti.java:463: warning: no @return
[WARNING] public OutputStreamMultiBuilder onRequest(BiConsumer<Long, Long> requestCallback) {
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/integrations/vault/vault/src/main/java/io/helidon/integrations/vault/spi/InjectionProvider.java:50: warning: no @param for instanceConfig
[WARNING] T apply(Vault vault, Config vaultConfig, InstanceConfig instanceConfig);
[WARNING] ^
[WARNING] /Users/jdipol/GitHub/barchetta/helidon/security/providers/common/src/main/java/io/helidon/security/providers/common/spi/AnnotationAnalyzer.java:264: warning: no @param for <T>
[WARNING] public <T> Builder register(Class<? super T> theClass, T anInstance) {
[WARNING] ^
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working docs P3
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants