Skip to content

Commit 40a43d6

Browse files
dfa1claude
andcommitted
docs: Markdown Javadoc links in remaining files (Sonar S7474)
Convert the remaining {@link X} to [X] and {@code x} to `x` across the rest of the codebase (older code outside the prior new-code sweep). Javadoc resolves every reference (build enforces failOnError + failOnWarnings). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
1 parent ca910da commit 40a43d6

65 files changed

Lines changed: 92 additions & 92 deletions

File tree

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/CliHandles.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
/// Shared handle plumbing for the interactive subcommands (`view`, `tui`).
1717
///
1818
/// A [VortexReader] uses a confined [java.lang.foreign.Arena], so the file must be
19-
/// opened and closed on the same {@link IoWorker} thread the TUI later dispatches I/O to. These
19+
/// opened and closed on the same [IoWorker] thread the TUI later dispatches I/O to. These
2020
/// helpers centralise that worker round-trip plus the local-file / http(s) target resolution.
2121
@SuppressWarnings("java:S106") // CLI tool: user-facing diagnostics go to System.err by design.
2222
final class CliHandles {

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77

88
/// Single-threaded I/O executor that owns one [io.github.dfa1.vortex.reader.VortexHandle].
99
///
10-
/// Vortex readers use a confined {@link java.lang.foreign.Arena}, so every
10+
/// Vortex readers use a confined [java.lang.foreign.Arena], so every
1111
/// `slice()` / `scan()` call must happen on the same thread that
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.

cli/src/main/java/io/github/dfa1/vortex/cli/tui/VortexInspectorTui.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public static void show(VortexHandle handle, InspectorTree.Progress progress) th
6262

6363
/// Variant that dispatches every `handle` I/O call onto the supplied
6464
/// [IoWorker]. Required when the handle was opened on a different
65-
/// thread (Vortex readers use a confined {@link java.lang.foreign.Arena},
65+
/// thread (Vortex readers use a confined [java.lang.foreign.Arena],
6666
/// so cross-thread access throws `WrongThreadException`).
6767
///
6868
/// Passing `null` for `worker` falls back to synchronous I/O

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717
/// into the alternate screen / raw mode. Class load alone is the safe, meaningful
1818
/// assertion: it forces every `Linker.downcallHandle` in the static initializer
1919
/// (tcgetattr, tcsetattr, cfmakeraw, ioctl) to resolve its libc symbol, throwing
20-
/// {@link UnsatisfiedLinkError} during `<clinit>` if an entry point is missing.
20+
/// [UnsatisfiedLinkError] during `<clinit>` if an entry point is missing.
2121
class PosixTerminalSmokeTest {
2222

2323
@Test

core/src/main/java/io/github/dfa1/vortex/core/DType.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public sealed interface DType
2828
/// [#withNullable(boolean)] so call sites read as a fluent adjective:
2929
/// `DType.i64().asNullable()`.
3030
///
31-
/// @return a new {@link DType} identical to this one but with `nullable = true`
31+
/// @return a new [DType] identical to this one but with `nullable = true`
3232
default DType asNullable() {
3333
return withNullable(true);
3434
}
@@ -158,13 +158,13 @@ static Decimal decimal(int precision, int scale) {
158158
/// .build();
159159
/// ```
160160
///
161-
/// @return a new {@link StructBuilder}
161+
/// @return a new [StructBuilder]
162162
static StructBuilder structBuilder() {
163163
return new StructBuilder();
164164
}
165165

166166
/// Fluent builder for [Struct] dtypes. Use [#structBuilder()] to obtain one.
167-
/// Preserves insertion order and rejects duplicate field names at {@link #build()}.
167+
/// Preserves insertion order and rejects duplicate field names at [#build()].
168168
final class StructBuilder {
169169
private final LinkedHashMap<String, DType> fields = new LinkedHashMap<>();
170170
private boolean nullable;
@@ -195,7 +195,7 @@ public StructBuilder asNullable() {
195195

196196
/// Builds the [Struct] dtype.
197197
///
198-
/// @return a new {@link Struct} reflecting every field added so far
198+
/// @return a new [Struct] reflecting every field added so far
199199
public Struct build() {
200200
return new Struct(
201201
java.util.List.copyOf(fields.keySet()),

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public boolean isSigned() {
6060
/// uses to identify a physical type.
6161
///
6262
/// Unlike `PType.values()[ordinal]`, this method validates the ordinal against the
63-
/// declared range and throws {@link VortexException} for crafted out-of-range values rather
63+
/// declared range and throws [VortexException] for crafted out-of-range values rather
6464
/// than the JDK's {@link ArrayIndexOutOfBoundsException}. Use this at every decode site that
6565
/// reads a ptype from untrusted metadata.
6666
///

core/src/main/java/io/github/dfa1/vortex/proto/ProtoReader.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
import java.nio.charset.StandardCharsets;
77

88
/// Stateful cursor over a [MemorySegment] that decodes proto3 wire-format primitives.
9-
/// Generated record types call into this from their {@code decode(...)} static factories.
9+
/// Generated record types call into this from their `decode(...)` static factories.
1010
/// Package-private — generated code lives in the same package.
1111
final class ProtoReader {
1212

@@ -108,7 +108,7 @@ String readString() throws IOException {
108108
}
109109

110110
/// Reads a length-delimited byte sequence into a fresh `byte[]`.
111-
/// Use {@link #readLenDelimSegment()} for zero-copy access when the consumer can hold a segment slice.
111+
/// Use [#readLenDelimSegment()] for zero-copy access when the consumer can hold a segment slice.
112112
byte[] readBytes() throws IOException {
113113
int len = readVarint32();
114114
ensureBytes(len);

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
@@ -93,7 +93,7 @@ void writeEmbedded(byte[] encoded) {
9393

9494
/// Reserves space for a length-delimited region whose payload size is unknown until written.
9595
/// Returns a mark to pass back to [#endLenDelim(int)]; the caller writes the payload
96-
/// in between. Avoids the alloc/copy round-trip of writing into a temporary {@code ProtoWriter}.
96+
/// in between. Avoids the alloc/copy round-trip of writing into a temporary `ProtoWriter`.
9797
///
9898
/// Reserves the worst-case 5 bytes for a varint32 length; {@link #endLenDelim} backpatches
9999
/// the actual length and shifts the payload left if a shorter varint suffices.

inspector/src/main/java/io/github/dfa1/vortex/inspect/InspectorTree.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,7 @@ public static InspectorTree build(VortexHandle handle) {
8787
/// resulting tree contains only structure derived from the file's footer
8888
/// and layout, so the call is essentially free on remote handles.
8989
///
90-
/// Use with {@link #peek(Node, VortexHandle)} for lazy on-demand resolution.
90+
/// Use with [#peek(Node, VortexHandle)] for lazy on-demand resolution.
9191
///
9292
/// @param handle open file handle
9393
/// @return immutable shallow inspector tree

inspector/src/main/java/io/github/dfa1/vortex/inspect/ZonedStatsSchema.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
/// vortex-layout/src/layouts/zoned/mod.rs</a> — `ZonedMetadata`):
1717
/// bytes [0..4) are the zone length as a little-endian `u32`;
1818
/// remaining bytes form a `Stat` bitset (LSB-first per byte). Each
19-
/// set bit at index `i` indicates that the {@link Stat} with that
19+
/// set bit at index `i` indicates that the [Stat] with that
2020
/// ordinal is present in the auxiliary stats table.
2121
/// - Schema construction
2222
/// (<a href="https://github.com/spiraldb/vortex/blob/develop/vortex-layout/src/layouts/zoned/schema.rs">

0 commit comments

Comments
 (0)