Skip to content

Commit 174860b

Browse files
authored
fixed remaining javadoc warnings (#1086)
1 parent 42c4184 commit 174860b

File tree

5 files changed

+18
-18
lines changed

5 files changed

+18
-18
lines changed

core/src/main/java/tech/tablesaw/api/BooleanColumn.java

+2-2
Original file line numberDiff line numberDiff line change
@@ -589,7 +589,7 @@ public BooleanColumn set(Selection rowSelection, boolean newValue) {
589589
*
590590
* @param rowSelection the rows to be updated
591591
* @param newValue a byte representation of boolean values. The only valid arguments are 0, 1, and
592-
* {@link BooleanColumnType:missingValueIndicator()}
592+
* {@link BooleanColumnType#missingValueIndicator()}
593593
*/
594594
public BooleanColumn set(Selection rowSelection, byte newValue) {
595595
for (int row : rowSelection) {
@@ -830,7 +830,7 @@ private static class BooleanColumnIterator implements Iterator<Boolean> {
830830

831831
/**
832832
* Returns {@code true} if the iteration has more elements. (In other words, returns {@code
833-
* true} if {@link #next} would return an element rather than throwing an exception.)
833+
* true} if {@link #next()} would return an element rather than throwing an exception.)
834834
*
835835
* @return {@code true} if the iteration has more elements
836836
*/

core/src/main/java/tech/tablesaw/api/InstantColumn.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -574,7 +574,7 @@ public InstantColumn set(int row, Column<Instant> column, int sourceRow) {
574574
return set(row, ((InstantColumn) column).getLongInternal(sourceRow));
575575
}
576576

577-
/** {@inheritDoc} */
577+
/** Returns the largest instant value in the column */
578578
public Instant max() {
579579
if (isEmpty()) {
580580
return null;

core/src/main/java/tech/tablesaw/api/Table.java

+13-13
Original file line numberDiff line numberDiff line change
@@ -1243,7 +1243,7 @@ public Table concat(Table tableToConcatenate) {
12431243
}
12441244

12451245
/**
1246-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1246+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
12471247
* using the given functions. This object implements reduce/aggregation operations on a table.
12481248
*
12491249
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1254,7 +1254,7 @@ public Summarizer summarize(String columName, AggregateFunction<?, ?>... functio
12541254
}
12551255

12561256
/**
1257-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1257+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
12581258
* using the given functions. This object implements reduce/aggregation operations on a table.
12591259
*
12601260
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1265,7 +1265,7 @@ public Summarizer summarize(List<String> columnNames, AggregateFunction<?, ?>...
12651265
}
12661266

12671267
/**
1268-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1268+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
12691269
* using the given functions. This object implements reduce/aggregation operations on a table.
12701270
*
12711271
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1277,7 +1277,7 @@ public Summarizer summarize(
12771277
}
12781278

12791279
/**
1280-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1280+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
12811281
* using the given functions. This object implements reduce/aggregation operations on a table.
12821282
*
12831283
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1289,7 +1289,7 @@ public Summarizer summarize(
12891289
}
12901290

12911291
/**
1292-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1292+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
12931293
* using the given functions. This object implements reduce/aggregation operations on a table.
12941294
*
12951295
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1306,7 +1306,7 @@ public Summarizer summarize(
13061306
}
13071307

13081308
/**
1309-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1309+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
13101310
* using the given functions. This object implements reduce/aggregation operations on a table.
13111311
*
13121312
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1317,7 +1317,7 @@ public Summarizer summarize(Column<?> numberColumn, AggregateFunction<?, ?>... f
13171317
}
13181318

13191319
/**
1320-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1320+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
13211321
* using the given functions. This object implements reduce/aggregation operations on a table.
13221322
*
13231323
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1329,7 +1329,7 @@ public Summarizer summarize(
13291329
}
13301330

13311331
/**
1332-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1332+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
13331333
* using the given functions. This object implements reduce/aggregation operations on a table.
13341334
*
13351335
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1344,7 +1344,7 @@ public Summarizer summarize(
13441344
}
13451345

13461346
/**
1347-
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
1347+
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
13481348
* using the given functions. This object implements reduce/aggregation operations on a table.
13491349
*
13501350
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
@@ -1667,9 +1667,9 @@ private Table transpose(
16671667
/**
16681668
* Melt implements the 'tidy' melt operation as described in these papers by Hadley Wickham.
16691669
*
1670-
* <p>Tidy concepts: {@see https://www.jstatsoft.org/article/view/v059i10}
1670+
* <p>Tidy concepts: see https://www.jstatsoft.org/article/view/v059i10
16711671
*
1672-
* <p>Cast function details: {@see https://www.jstatsoft.org/article/view/v021i12}
1672+
* <p>Cast function details: see https://www.jstatsoft.org/article/view/v021i12
16731673
*
16741674
* <p>In short, melt turns columns into rows, but in a particular way. Used with the cast method,
16751675
* it can help make data tidy. In a tidy dataset, every variable is a column and every observation
@@ -1794,9 +1794,9 @@ private void writeIdVariables(List<String> idVariables, Table result, Row row) {
17941794
* <p>Variable columns are returned in an arbitrary order. Use {@link #reorderColumns(String...)}
17951795
* if column order is important.
17961796
*
1797-
* <p>Tidy concepts: {@see https://www.jstatsoft.org/article/view/v059i10}
1797+
* <p>Tidy concepts: see https://www.jstatsoft.org/article/view/v059i10
17981798
*
1799-
* <p>Cast function details: {@see https://www.jstatsoft.org/article/view/v021i12}
1799+
* <p>Cast function details: see https://www.jstatsoft.org/article/view/v021i12
18001800
*/
18011801
public Table cast() {
18021802
StringColumn variableNames = stringColumn(MELT_VARIABLE_COLUMN_NAME);

core/src/main/java/tech/tablesaw/columns/numbers/LongColumnType.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public LongColumn create(String name) {
3333
return LongColumn.create(name);
3434
}
3535

36-
/** {@inheritDoc} */
36+
/** Returns the default parser used to convert strings to long values */
3737
public LongParser defaultParser() {
3838
return DEFAULT_PARSER;
3939
}

core/src/main/java/tech/tablesaw/table/TableSlice.java

+1-1
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ public String name() {
135135
return name;
136136
}
137137

138-
/** {@inheritDoc} */
138+
/** Returns the backing table for this slice */
139139
public Table getTable() {
140140
return table;
141141
}

0 commit comments

Comments
 (0)