Skip to content

Commit 1f99309

Browse files
committed
add javadoc to release
1 parent 237a333 commit 1f99309

File tree

8 files changed

+23
-5
lines changed

8 files changed

+23
-5
lines changed

common/src/main/java/com/datastax/oss/common/sink/AbstractSinkRecord.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ public interface AbstractSinkRecord {
4242
/**
4343
* Reference timestamp.
4444
*
45-
* @return
45+
* @return the timestamp
4646
*/
4747
public Long timestamp();
4848

common/src/main/java/com/datastax/oss/common/sink/AbstractSinkTask.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,7 +259,7 @@ protected abstract void handleFailure(
259259
/**
260260
* Called in case of successful processing.
261261
*
262-
* @param record
262+
* @param record the record for which we reported success
263263
*/
264264
protected void handleSuccess(AbstractSinkRecord record) {}
265265

common/src/main/java/com/datastax/oss/common/sink/AbstractStruct.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ public interface AbstractStruct {
2121
/**
2222
* Access a field
2323
*
24-
* @param field
24+
* @param field the field to get
2525
* @return the value of the field, or null
2626
*/
2727
public Object get(String field);

common/src/main/java/com/datastax/oss/common/sink/metadata/MetadataCreator.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ public class MetadataCreator {
4949

5050
/**
5151
* Create a metadata object describing the structure of the given key or value (extracted from a
52-
* {@link SinkRecord} and a data object that homogenizes interactions with the given key/value
52+
* {@link AbstractStruct} and a data object that homogenizes interactions with the given key/value
5353
* (e.g. an implementation of {@link KeyOrValue}).
5454
*
5555
* @param keyOrValue the key or value

common/src/main/java/com/datastax/oss/common/sink/record/KeyValueRecord.java

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
*/
1616
package com.datastax.oss.common.sink.record;
1717

18+
import com.datastax.oss.common.sink.AbstractSinkRecord;
1819
import com.datastax.oss.common.sink.AbstractSinkRecordHeader;
1920
import edu.umd.cs.findbugs.annotations.NonNull;
2021
import edu.umd.cs.findbugs.annotations.Nullable;
@@ -23,7 +24,8 @@
2324
import java.util.stream.Collectors;
2425

2526
/**
26-
* The fully parsed {@link SinkRecord} in a form where we can apply mappings of fields to columns.
27+
* The fully parsed {@link AbstractSinkRecord} in a form where we can apply mappings of fields to
28+
* columns.
2729
*/
2830
public class KeyValueRecord implements Record {
2931
@Nullable private final KeyOrValue key;

common/src/main/java/com/datastax/oss/common/sink/record/StructData.java

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
package com.datastax.oss.common.sink.record;
1717

1818
import com.datastax.oss.common.sink.AbstractField;
19+
import com.datastax.oss.common.sink.AbstractSinkRecord;
1920
import com.datastax.oss.common.sink.AbstractStruct;
2021
import edu.umd.cs.findbugs.annotations.Nullable;
2122
import java.nio.ByteBuffer;

common/src/main/java/com/datastax/oss/common/sink/state/LifeCycleManager.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -473,6 +473,8 @@ private static InstanceState buildInstanceState(CqlSession session, CassandraSin
473473
* Create a new {@link CqlSession} based on the config
474474
*
475475
* @param config the sink config
476+
* @param version the version of the application
477+
* @param applicationName the name of the application
476478
* @return a new CqlSession
477479
*/
478480
@VisibleForTesting

pom.xml

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -617,6 +617,19 @@ limitations under the License.]]></inlineHeader>
617617
<id>release</id>
618618
<build>
619619
<plugins>
620+
<plugin>
621+
<groupId>org.apache.maven.plugins</groupId>
622+
<artifactId>maven-javadoc-plugin</artifactId>
623+
<version>3.2.0</version>
624+
<executions>
625+
<execution>
626+
<goals>
627+
<goal>javadoc-no-fork</goal>
628+
</goals>
629+
<phase>package</phase>
630+
</execution>
631+
</executions>
632+
</plugin>
620633
<plugin>
621634
<artifactId>maven-gpg-plugin</artifactId>
622635
<executions>

0 commit comments

Comments
 (0)