Skip to content

Commit dd03eb7

Browse files
dfa1claude
andcommitted
docs: convert remaining {@link}/{@code} to Markdown Javadoc (Sonar S7474)
Final sweep of hand-written sources (162 tags across 43 files). Generated proto records are left untouched (regenerated from CodeGen, not analyzed). Javadoc resolves every reference (failOnError + failOnWarnings). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent a03b459 commit dd03eb7

43 files changed

Lines changed: 115 additions & 115 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎cli/src/main/java/io/github/dfa1/vortex/cli/tui/IoWorker.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
/// opened the file. The TUI dispatches all such calls to this worker so the
1313
/// render loop on the main thread never crosses the arena's owning thread.
1414
///
15-
/// {@link #pending()} drives the status-line counter; callers should check it
15+
/// [#pending()] drives the status-line counter; callers should check it
1616
/// when computing UI state.
1717
public final class IoWorker implements AutoCloseable {
1818

@@ -40,8 +40,8 @@ public void submit(Runnable task) {
4040
return;
4141
}
4242
pending.incrementAndGet();
43-
// Unbounded {@link LinkedBlockingQueue} never rejects on capacity; {@code add} is the
44-
// right idiom (throws {@code IllegalStateException} on the impossible case) so we don't
43+
// Unbounded [LinkedBlockingQueue] never rejects on capacity; `add` is the
44+
// right idiom (throws `IllegalStateException` on the impossible case) so we don't
4545
// silently drop tasks if anyone ever swaps in a bounded queue.
4646
queue.add(() -> {
4747
try {

‎cli/src/test/java/io/github/dfa1/vortex/cli/FilterCommandTest.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ class FilterCommandTest {
2323

2424
@BeforeEach
2525
void setUp() throws IOException {
26-
// 3-row Vortex file with one I64 column {@code id} = [1, 2, 3].
26+
// 3-row Vortex file with one I64 column `id` = [1, 2, 3].
2727
file = writeSmallVortex(tmp, "filter.vortex");
2828
}
2929

‎cli/src/test/java/io/github/dfa1/vortex/cli/ImportCommandTest.java‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ void noArgs_returnsUsageError() {
3131

3232
@Test
3333
void delimiterMissingValue_returnsUsageError() {
34-
// Given / When — {@code --delimiter} at the tail with no value
34+
// Given / When — `--delimiter` at the tail with no value
3535
CliTestSupport.Captured result = capture(() ->
3636
ImportCommand.run(new String[]{"import", "--delimiter"}));
3737

@@ -125,9 +125,9 @@ void csvWithCustomDelimiter_imports(@TempDir Path tmp) throws IOException {
125125
ImportCommand.run(new String[]{"import", "--delimiter", "\t", csv.toString()}));
126126

127127
// Then — without the explicit delimiter the import would treat the whole row as one
128-
// column. Success here confirms the {@code --delimiter} flag plumbs through.
129-
// Output filename: input is {@code data.tsv}, deriveOutputPath only strips
130-
// {@code .csv}/{@code .parquet} suffixes, so the result is {@code data.tsv.vortex}.
128+
// column. Success here confirms the `--delimiter` flag plumbs through.
129+
// Output filename: input is `data.tsv`, deriveOutputPath only strips
130+
// `.csv`/`.parquet` suffixes, so the result is `data.tsv.vortex`.
131131
assertThat(result.status()).isEqualTo(ExitStatus.OK);
132132
assertThat(tmp.resolve("data.tsv.vortex")).exists();
133133
}

‎cli/src/test/java/io/github/dfa1/vortex/cli/tui/term/KeyDecoderTest.java‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -124,8 +124,8 @@ void next_multiDigitTildeCode_handlesTwoDigits() throws IOException {
124124

125125
@Test
126126
void next_ss3SequenceVariant_decodesArrows() throws IOException {
127-
// Given — DEC keypad / VT100 application-cursor mode uses {@code ESC O A}
128-
// instead of {@code ESC [ A}. KeyDecoder must accept both prefixes so the
127+
// Given — DEC keypad / VT100 application-cursor mode uses `ESC O A`
128+
// instead of `ESC [ A`. KeyDecoder must accept both prefixes so the
129129
// TUI works under tmux / screen / putty configurations that ship SS3.
130130
assertThat(KeyDecoder.next(bytes(0x1B, 'O', 'A'))).isEqualTo(Key.ArrowUp.INSTANCE);
131131
assertThat(KeyDecoder.next(bytes(0x1B, 'O', 'D'))).isEqualTo(Key.ArrowLeft.INSTANCE);
@@ -135,7 +135,7 @@ void next_ss3SequenceVariant_decodesArrows() throws IOException {
135135

136136
@Test
137137
void next_unknownEscapePrefix_yieldsEscape() throws IOException {
138-
// Given — {@code ESC X} (X is neither '[' nor 'O') is not a recognised
138+
// Given — `ESC X` (X is neither '[' nor 'O') is not a recognised
139139
// CSI or SS3 sequence. Must return Escape rather than try to decode further.
140140
ByteArrayInputStream in = bytes(0x1B, 'X', 'A');
141141

@@ -148,7 +148,7 @@ void next_unknownEscapePrefix_yieldsEscape() throws IOException {
148148

149149
@Test
150150
void next_eofMidTildeSequence_returnsEof() throws IOException {
151-
// Given — partial {@code ESC [ 5} with no trailing tilde / digit
151+
// Given — partial `ESC [ 5` with no trailing tilde / digit
152152
ByteArrayInputStream in = bytes(0x1B, '[', '5');
153153

154154
// When
@@ -160,7 +160,7 @@ void next_eofMidTildeSequence_returnsEof() throws IOException {
160160

161161
@Test
162162
void next_tildeWithoutTrailingTildeChar_yieldsEscape() throws IOException {
163-
// Given — {@code ESC [ 5 x}: digit followed by a non-tilde non-digit.
163+
// Given — `ESC [ 5 x`: digit followed by a non-tilde non-digit.
164164
// The trailing character must be re-yielded by the next call, not lost.
165165
ByteArrayInputStream in = bytes(0x1B, '[', '5', 'x', 'y');
166166

@@ -177,7 +177,7 @@ void next_tildeWithoutTrailingTildeChar_yieldsEscape() throws IOException {
177177
@Test
178178
void next_controlByte_returnsCharWithRawValue() throws IOException {
179179
// Given — Ctrl-C is 0x03, no special handling — surfaced as Char so the
180-
// TUI's keymap can match it via {@code Key.Char(3)} if needed.
180+
// TUI's keymap can match it via `Key.Char(3)` if needed.
181181
ByteArrayInputStream in = bytes(0x03);
182182

183183
// When

‎core/src/main/java/io/github/dfa1/vortex/core/PType.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -61,13 +61,13 @@ public boolean isSigned() {
6161
///
6262
/// Unlike `PType.values()[ordinal]`, this method validates the ordinal against the
6363
/// declared range and throws [VortexException] for crafted out-of-range values rather
64-
/// than the JDK's {@link ArrayIndexOutOfBoundsException}. Use this at every decode site that
64+
/// than the JDK's [ArrayIndexOutOfBoundsException]. Use this at every decode site that
6565
/// reads a ptype from untrusted metadata.
6666
///
6767
/// @param ordinal the enum ordinal, typically taken from a Protobuf `ptype` field
68-
/// @return the {@link PType} for the given ordinal
68+
/// @return the [PType] for the given ordinal
6969
/// @throws VortexException if `ordinal` is negative or greater than the largest defined
70-
/// {@link PType} ordinal
70+
/// [PType] ordinal
7171
public static PType fromOrdinal(int ordinal) {
7272
PType[] all = values();
7373
if (ordinal < 0 || ordinal >= all.length) {

‎core/src/main/java/io/github/dfa1/vortex/encoding/TimeUnit.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ public enum TimeUnit {
1010
Milliseconds,
1111
/// Seconds — ordinal 3.
1212
Seconds,
13-
/// Days — ordinal 4. Not sub-dividable; {@link #divisor()} throws for this value.
13+
/// Days — ordinal 4. Not sub-dividable; [#divisor()] throws for this value.
1414
Days;
1515

1616
/// Returns the `TimeUnit` for the given wire tag byte.

‎core/src/main/java/io/github/dfa1/vortex/proto/ProtoWriter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ void writeEmbedded(byte[] encoded) {
9595
/// Returns a mark to pass back to [#endLenDelim(int)]; the caller writes the payload
9696
/// in between. Avoids the alloc/copy round-trip of writing into a temporary `ProtoWriter`.
9797
///
98-
/// Reserves the worst-case 5 bytes for a varint32 length; {@link #endLenDelim} backpatches
98+
/// Reserves the worst-case 5 bytes for a varint32 length; [#endLenDelim] backpatches
9999
/// the actual length and shifts the payload left if a shorter varint suffices.
100100
int beginLenDelim() {
101101
ensure(MAX_LEN_VARINT);

‎jdbc/src/main/java/io/github/dfa1/vortex/jdbc/JdbcImporter.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
///
3030
/// The schema is derived from [ResultSetMetaData] — no type inference is needed.
3131
/// SQL NULL values are mapped to `0`, `0.0`, `false`, or `""` depending on column type.
32-
/// Use {@link JdbcImportOptions#withFetchSize} to control driver-side streaming for large tables.
32+
/// Use [JdbcImportOptions#withFetchSize] to control driver-side streaming for large tables.
3333
public final class JdbcImporter {
3434

3535
private JdbcImporter() {

‎performance/src/main/java/io/github/dfa1/vortex/performance/ParquetVsVortexReadBenchmark.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,10 @@
4242
///
4343
/// Two Parquet variants:
4444
/// - `parquetRead` / `parquetReadMultiColumn`: batch column API
45-
/// ({@link ColumnReader#nextBatch()} + {@link ColumnReader#getDoubles()}) —
45+
/// ([ColumnReader#nextBatch()] + [ColumnReader#getDoubles()]) —
4646
/// apples-to-apples comparison with Vortex's batch fold.
4747
/// - `parquetReadRowByRow` / `parquetReadMultiColumnRowByRow`:
48-
/// Hardwood row cursor ({@link RowReader}) — measures row-oriented API overhead
48+
/// Hardwood row cursor ([RowReader]) — measures row-oriented API overhead
4949
/// on top of format decode cost.
5050
///
5151
/// Override the Parquet source with: `-Dbench.parquet=/path/to/file.parquet`

‎performance/src/main/java/io/github/dfa1/vortex/performance/RustVsJavaFilterBenchmark.java‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@
4242
/// with a `close > threshold` predicate at varying selectivity.
4343
///
4444
/// Phase 0 instrument for ADR 0010 (lazy decode). The threshold is chosen at
45-
/// setup time so each {@link #selectivity} value selects approximately that
45+
/// setup time so each [#selectivity] value selects approximately that
4646
/// fraction of rows. Both readers report the sum of surviving close values so
4747
/// the JVM cannot elide the per-row work.
4848
///
@@ -52,7 +52,7 @@
5252
///
5353
/// Requires a pre-existing OHLC file:
5454
/// `-Dvortex.bench.ohlc=/path/to/file.vtx`. Generate one by running
55-
/// {@link RustVsJavaReadBenchmark} first with the same `vortex.bench.ohlc`
55+
/// [RustVsJavaReadBenchmark] first with the same `vortex.bench.ohlc`
5656
/// pointing at the path you want (the read benchmark will write it lazily if
5757
/// the file does not exist yet).
5858
@State(Scope.Benchmark)
@@ -74,7 +74,7 @@ public class RustVsJavaFilterBenchmark {
7474
}
7575

7676
/// Target fraction of rows that should satisfy `close > threshold`.
77-
/// The threshold is computed in {@link #setup()} from a sample of the
77+
/// The threshold is computed in [#setup()] from a sample of the
7878
/// "close" column; the realised selectivity is reported in the setup log
7979
/// and may differ slightly from this value on small samples.
8080
@Param({"0.001", "0.01", "0.1", "1.0"})

0 commit comments

Comments
 (0)