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.

Sign up for GitHub

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

Jump to bottom

Errors in javadocs #117

Open
subkanthi opened this issue Jun 4, 2023 · 1 comment
Open

Errors in javadocs #117

subkanthi opened this issue Jun 4, 2023 · 1 comment
Labels
code-quality Affects the developer experience when working in our codebase.

Comments

@subkanthi
Copy link
Contributor

subkanthi commented Jun 4, 2023 •
edited by sync-by-unito bot
Loading

There are lot of errors in javadocs that need to be fixed, disabling doc generation for now.

Error:  Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.3.0:jar (attach-javadocs) on project kafka-connect-ably: MavenReportException: Error while generating Javadoc: 
Error:  Exit code: 1 - /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/ChannelSinkConnector.java:36: warning: no comment
Error:  public class ChannelSinkConnector extends SinkConnector {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/ChannelSinkTask.java:28: warning: no comment
Error:  public class ChannelSinkTask extends SinkTask {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/ChannelSinkTask.java:39: warning: no comment
Error:      public ChannelSinkTask() {}
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/batch/BatchProcessingThread.java:21: warning: no comment
Error:      public BatchProcessingThread(List<SinkRecord> sinkRecords, DefaultAblyBatchClient ablyBatchClient) {
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/AblyClient.java:12: warning: no description for @param
Error:       * @param records
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/AblyClient.java:13: warning: no description for @throws
Error:       * @throws ConnectException
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/AblyClient.java:14: warning: no description for @throws
Error:       * @throws AblyException
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/AblyClient.java:9: warning: no comment
Error:  public interface AblyClient {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/AblyClientFactory.java:17: warning: no @throws for io.ably.lib.types.AblyException
Error:      AblyClient create(Map<String, String> settings) throws ChannelSinkConnectorConfig.ConfigException, AblyException;
Error:                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/AblyClientFactory.java:8: warning: no comment
Error:  public interface AblyClientFactory {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/BatchSpec.java:9: warning: no comment
Error:  final public class BatchSpec {
Error:               ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/BatchSpec.java:12: warning: no comment
Error:      public BatchSpec(Set<String> channels, List<Message> messages) {
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/BatchSpec.java:16: warning: no comment
Error:      public Set<String> getChannels() {
Error:                         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/BatchSpec.java:19: warning: no comment
Error:      public List<Message> getMessages() {
Error:                           ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:52: warning: no description for @throws
Error:       * @throws ConnectException
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:74: warning: no description for @param
Error:       * @param sinkRecords
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:75: warning: no description for @return
Error:       * @return
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:120: warning: no description for @param
Error:       * @param batches
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:121: warning: no description for @throws
Error:       * @throws AblyException
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:33: warning: no comment
Error:      protected final ChannelSinkMapping channelSinkMapping;
Error:                                         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:35: warning: no comment
Error:      protected final ChannelSinkConnectorConfig connectorConfig;
Error:                                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:34: warning: no comment
Error:      protected final MessageSinkMapping messageSinkMapping;
Error:                                         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:40: warning: no comment
Error:      public DefaultAblyBatchClient(ChannelSinkConnectorConfig connectorConfig, ChannelSinkMapping channelSinkMapping,
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyBatchClient.java:99: warning: no comment
Error:      protected boolean shouldSkip(SinkRecord record) {
Error:                        ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/client/DefaultAblyClientFactory.java:19: warning: no comment
Error:  public class DefaultAblyClientFactory implements AblyClientFactory {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelConfig.java:5: warning: no comment
Error:  public interface ChannelConfig {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelConfig.java:6: warning: no comment
Error:      String getName();
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelConfig.java:8: warning: no comment
Error:      ChannelOptions getOptions() throws ChannelSinkConnectorConfig.ConfigException;
Error:                     ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:29: warning: no comment
Error:  public class ChannelSinkConnectorConfig extends AbstractConfig {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:224: warning: no comment
Error:      public static class ConfigException extends Exception {
Error:                    ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:197: warning: no comment
Error:      public static final String BATCH_EXECUTION_FLUSH_TIME = "batchExecutionFlushTime";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:199: warning: no comment
Error:      public static final String BATCH_EXECUTION_FLUSH_TIME_DEFAULT = "5000";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:205: warning: no comment
Error:      public static final String BATCH_EXECUTION_MAX_BUFFER_SIZE = "batchExecutionMaxBufferSize";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:207: warning: no comment
Error:      public static final String BATCH_EXECUTION_MAX_BUFFER_SIZE_DEFAULT = "1000";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:183: warning: no comment
Error:      public static final String BATCH_EXECUTION_THREAD_POOL_SIZE = "batchExecutionThreadPoolSize";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:185: warning: no comment
Error:      public static final String BATCH_EXECUTION_THREAD_POOL_SIZE_DEFAULT = "10";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:31: warning: no comment
Error:      public static final String CHANNEL_CONFIG = "channel";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:163: warning: no comment
Error:      public static final String CLIENT_ASYNC_HTTP_THREADPOOL_SIZE = "client.async.http.threadpool.size";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:70: warning: no comment
Error:      public static final String CLIENT_AUTO_CONNECT = "client.auto.connect";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:171: warning: no comment
Error:      public static final String CLIENT_CHANNEL_CIPHER_KEY = "client.channel.cipher.key";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:175: warning: no comment
Error:      public static final String CLIENT_CHANNEL_PARAMS = "client.channel.params";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:155: warning: no comment
Error:      public static final String CLIENT_CHANNEL_RETRY_TIMEOUT = "client.channel.retry.timeout";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:79: warning: no comment
Error:      public static final String CLIENT_ECHO_MESSAGES = "client.echo.messages";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:110: warning: no comment
Error:      public static final String CLIENT_ENVIRONMENT = "client.environment";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:134: warning: no comment
Error:      public static final String CLIENT_FALLBACK_HOSTS = "client.fallback.hosts";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:124: warning: no comment
Error:      public static final String CLIENT_HTTP_MAX_RETRY_COUNT = "client.http.max.retry.count";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:118: warning: no comment
Error:      public static final String CLIENT_HTTP_OPEN_TIMEOUT = "client.http.open.timeout";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:121: warning: no comment
Error:      public static final String CLIENT_HTTP_REQUEST_TIMEOUT = "client.http.request.timeout";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:40: warning: no comment
Error:      public static final String CLIENT_ID = "client.id";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:114: warning: no comment
Error:      public static final String CLIENT_IDEMPOTENT_REST_PUBLISHING = "client.idempotent.rest";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:36: warning: no comment
Error:      public static final String CLIENT_KEY = "client.key";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:46: warning: no comment
Error:      public static final String CLIENT_LOG_LEVEL = "client.loglevel";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:62: warning: no comment
Error:      public static final String CLIENT_PORT = "client.port";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:83: warning: no comment
Error:      public static final String CLIENT_PROXY = "client.proxy";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:86: warning: no comment
Error:      public static final String CLIENT_PROXY_HOST = "client.proxy.host";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:102: warning: no comment
Error:      public static final String CLIENT_PROXY_NON_PROXY_HOSTS = "client.proxy.non.proxy.hosts";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:98: warning: no comment
Error:      public static final String CLIENT_PROXY_PASSWORD = "client.proxy.password";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:90: warning: no comment
Error:      public static final String CLIENT_PROXY_PORT = "client.proxy.port";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:106: warning: no comment
Error:      public static final String CLIENT_PROXY_PREF_AUTH_TYPE = "client.proxy.pref.auth.type";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:94: warning: no comment
Error:      public static final String CLIENT_PROXY_USERNAME = "client.proxy.username";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:167: warning: no comment
Error:      public static final String CLIENT_PUSH_FULL_WAIT = "client.push.full.wait";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:74: warning: no comment
Error:      public static final String CLIENT_QUEUE_MESSAGES = "client.queue.messages";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:58: warning: no comment
Error:      public static final String CLIENT_REALTIME_HOST = "client.realtime.host";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:128: warning: no comment
Error:      public static final String CLIENT_REALTIME_REQUEST_TIMEOUT = "client.realtime.request.timeout";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:54: warning: no comment
Error:      public static final String CLIENT_REST_HOST = "client.rest.host";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:50: warning: no comment
Error:      public static final String CLIENT_TLS = "client.tls";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:66: warning: no comment
Error:      public static final String CLIENT_TLS_PORT = "client.tls.port";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:138: warning: no comment
Error:      public static final String CLIENT_TOKEN_PARAMS = "client.token.params";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:145: warning: no comment
Error:      public static final String CLIENT_TOKEN_PARAMS_CAPABILITY = "client.token.params.capability";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:150: warning: no comment
Error:      public static final String CLIENT_TOKEN_PARAMS_CLIENT_ID = "client.token.params.client.id";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:141: warning: no comment
Error:      public static final String CLIENT_TOKEN_PARAMS_TTL = "client.token.params.ttl";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:158: warning: no comment
Error:      public static final String CLIENT_TRANSPORT_PARAMS = "client.transport.params";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:222: warning: no comment
Error:      public final ClientOptions clientOptions;
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:33: warning: no comment
Error:      public static final String MESSAGE_CONFIG = "message.name";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:187: warning: no comment
Error:      public static final String MESSAGE_PAYLOAD_SIZE_MAX = "messagePayloadSizeMax";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:190: warning: no comment
Error:      public static final int MESSAGE_PAYLOAD_SIZE_MAX_DEFAULT = 64 * 1024;
Error:                              ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:179: warning: no comment
Error:      public static final String SKIP_ON_KEY_ABSENCE = "skipOnKeyAbsence";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:236: warning: no comment
Error:      public ChannelSinkConnectorConfig(Map<?, ?> originals) {
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:314: warning: no comment
Error:      public static ConfigDef createConfig() {
Error:                              ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:227: warning: no comment
Error:          public ConfigException(String message) {
Error:                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ChannelSinkConnectorConfig.java:231: warning: no comment
Error:          public ConfigException(String message, Exception cause) {
Error:                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:8: warning: no comment
Error:  public class ConfigValueEvaluator {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:13: warning: no comment
Error:      public static class Result {
Error:                    ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:30: warning: no comment
Error:      public static final String KEY_TOKEN = "#{key}";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:31: warning: no comment
Error:      public static final String TOPIC_TOKEN = "#{topic}";
Error:                                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:16: warning: no comment
Error:          public Result(boolean skip, String value) {
Error:                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:21: warning: no comment
Error:          public String getValue() {
Error:                        ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/ConfigValueEvaluator.java:25: warning: no comment
Error:          public boolean shouldSkip() {
Error:                         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/DefaultChannelConfig.java:17: warning: no comment
Error:  public class DefaultChannelConfig implements ChannelConfig {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/DefaultChannelConfig.java:20: warning: no comment
Error:      public DefaultChannelConfig(final ChannelSinkConnectorConfig sinkConnectorConfig) {
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/KafkaRecordErrorReporter.java:5: warning: no comment
Error:  public interface KafkaRecordErrorReporter {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/config/KafkaRecordErrorReporter.java:6: warning: no comment
Error:      void reportError(SinkRecord record, Exception e);
Error:           ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/ChannelSinkMapping.java:14: warning: no description for @param
Error:       * @param sinkRecord
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/ChannelSinkMapping.java:15: warning: no description for @return
Error:       * @return
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/ChannelSinkMapping.java:16: error: exception not thrown: io.ably.lib.types.AblyException
Error:       * @throws AblyException
Error:                 ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/ChannelSinkMapping.java:16: warning: no description for @throws
Error:       * @throws AblyException
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/ChannelSinkMapping.java:11: warning: no comment
Error:  public interface ChannelSinkMapping {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/DefaultChannelSinkMapping.java:9: warning: no comment
Error:  public class DefaultChannelSinkMapping implements ChannelSinkMapping {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/DefaultChannelSinkMapping.java:13: warning: no comment
Error:      public DefaultChannelSinkMapping(ConfigValueEvaluator configValueEvaluator, ChannelConfig channelConfig) {
Error:             ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/DefaultMessageSinkMapping.java:20: warning: no comment
Error:  public class DefaultMessageSinkMapping implements MessageSinkMapping {
Error:         ^
Error:  /home/runner/work/kafka-connect-ably/kafka-connect-ably/src/main/java/com/ably/kafka/connect/mapping/DefaultMessageSinkMapping.java:26: warning: no comment
Error:      public DefaultMessageSinkMapping(@Nonnull ChannelSinkConnectorConfig config, @Nonnull ConfigValueEvaluator configValueEvaluator) {
Error:             ^
Error:  
Error:  Command line was: /opt/hostedtoolcache/Java_Adopt_jdk/16.0.2-7/x64/bin/javadoc @options @packages
Error:  
Error:  Refer to the generated Javadoc files in '/home/runner/work/kafka-connect-ably/kafka-connect-ably/target/apidocs' dir.
Error:  -> [Help 1]
Error:  
Error:  To see the full stack trace of the errors, re-run Maven with the -e switch.
Error:  Re-run Maven using the -X switch to enable full debug logging.
Error:  
Error:  For more information about the errors and possible solutions, please read the following articles:
Error:  [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
Error: Process completed with exit code 1.

┆Issue is synchronized with this Jira Task by Unito
@sync-by-unito
Copy link

sync-by-unito bot commented Jun 4, 2023

➤ Automation for Jira commented:

The link to the corresponding Jira issue is https://ably.atlassian.net/browse/SDK-3619

@mattheworiordan mattheworiordan added the code-quality Affects the developer experience when working in our codebase. label Dec 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
code-quality Affects the developer experience when working in our codebase.
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mattheworiordan @subkanthi