Skip to content

Commit

Permalink
fixed remaining javadoc warnings (#1086)
Browse files Browse the repository at this point in the history
  • Loading branch information
lwhite1 authored Mar 30, 2022
1 parent 42c4184 commit 174860b
Show file tree
Hide file tree
Showing 5 changed files with 18 additions and 18 deletions.
4 changes: 2 additions & 2 deletions core/src/main/java/tech/tablesaw/api/BooleanColumn.java
Original file line number Diff line number Diff line change
Expand Up @@ -589,7 +589,7 @@ public BooleanColumn set(Selection rowSelection, boolean newValue) {
*
* @param rowSelection the rows to be updated
* @param newValue a byte representation of boolean values. The only valid arguments are 0, 1, and
* {@link BooleanColumnType:missingValueIndicator()}
* {@link BooleanColumnType#missingValueIndicator()}
*/
public BooleanColumn set(Selection rowSelection, byte newValue) {
for (int row : rowSelection) {
Expand Down Expand Up @@ -830,7 +830,7 @@ private static class BooleanColumnIterator implements Iterator<Boolean> {

/**
* Returns {@code true} if the iteration has more elements. (In other words, returns {@code
* true} if {@link #next} would return an element rather than throwing an exception.)
* true} if {@link #next()} would return an element rather than throwing an exception.)
*
* @return {@code true} if the iteration has more elements
*/
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/tech/tablesaw/api/InstantColumn.java
Original file line number Diff line number Diff line change
Expand Up @@ -574,7 +574,7 @@ public InstantColumn set(int row, Column<Instant> column, int sourceRow) {
return set(row, ((InstantColumn) column).getLongInternal(sourceRow));
}

/** {@inheritDoc} */
/** Returns the largest instant value in the column */
public Instant max() {
if (isEmpty()) {
return null;
Expand Down
26 changes: 13 additions & 13 deletions core/src/main/java/tech/tablesaw/api/Table.java
Original file line number Diff line number Diff line change
Expand Up @@ -1243,7 +1243,7 @@ public Table concat(Table tableToConcatenate) {
}

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

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

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

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

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

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

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

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

/**
* Returns an {@link Summarizer} that can be used to summarize the column with the given name(s)
* Returns a {@link Summarizer} that can be used to summarize the column with the given name(s)
* using the given functions. This object implements reduce/aggregation operations on a table.
*
* <p>Summarizer can return the results as a table using the Summarizer:apply() method. Summarizer
Expand Down Expand Up @@ -1667,9 +1667,9 @@ private Table transpose(
/**
* Melt implements the 'tidy' melt operation as described in these papers by Hadley Wickham.
*
* <p>Tidy concepts: {@see https://www.jstatsoft.org/article/view/v059i10}
* <p>Tidy concepts: see https://www.jstatsoft.org/article/view/v059i10
*
* <p>Cast function details: {@see https://www.jstatsoft.org/article/view/v021i12}
* <p>Cast function details: see https://www.jstatsoft.org/article/view/v021i12
*
* <p>In short, melt turns columns into rows, but in a particular way. Used with the cast method,
* it can help make data tidy. In a tidy dataset, every variable is a column and every observation
Expand Down Expand Up @@ -1794,9 +1794,9 @@ private void writeIdVariables(List<String> idVariables, Table result, Row row) {
* <p>Variable columns are returned in an arbitrary order. Use {@link #reorderColumns(String...)}
* if column order is important.
*
* <p>Tidy concepts: {@see https://www.jstatsoft.org/article/view/v059i10}
* <p>Tidy concepts: see https://www.jstatsoft.org/article/view/v059i10
*
* <p>Cast function details: {@see https://www.jstatsoft.org/article/view/v021i12}
* <p>Cast function details: see https://www.jstatsoft.org/article/view/v021i12
*/
public Table cast() {
StringColumn variableNames = stringColumn(MELT_VARIABLE_COLUMN_NAME);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ public LongColumn create(String name) {
return LongColumn.create(name);
}

/** {@inheritDoc} */
/** Returns the default parser used to convert strings to long values */
public LongParser defaultParser() {
return DEFAULT_PARSER;
}
Expand Down
2 changes: 1 addition & 1 deletion core/src/main/java/tech/tablesaw/table/TableSlice.java
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@ public String name() {
return name;
}

/** {@inheritDoc} */
/** Returns the backing table for this slice */
public Table getTable() {
return table;
}
Expand Down

0 comments on commit 174860b

Please sign in to comment.