Skip to content

Commit 594338d

Browse files
dfa1claude
andcommitted
docs: repair seven broken javadoc references
`javadoc:javadoc` failed with "reference not found" in three modules. Every case was a stale link, mostly left by past refactors: - StructArray: [io.github.dfa1.vortex.encoding.StructEncoding] — that package no longer exists; the type is now reader.decode.StructEncodingDecoder. - NullableData: [Encoding] — split into EncodingEncoder/EncodingDecoder. - ArrayStats: [#mostFrequentValueBits()] — the record component is mostFrequentBits. - Chunk: [DType] and ByteBoolEncodingDecoder: [BoolArray] — neither type is imported, so neither resolved. Chunk now uses the FQN (DType appears only in prose); ByteBool points at MaterializedBoolArray, which is both imported and what decode() actually returns. - NullableData: [io.github.dfa1.vortex.reader.array.MaskedArray] and CodeGen: [FbsTable]/[FbsBuilder] — cross-module targets that are deliberately unreachable. Writer must not depend on reader, and fbs-gen emits the core.fbs runtime classes rather than depending on them, so both are now named as text with the reason stated. Comment-only: no signature, no behavior. Verified with `./mvnw package -DskipTests javadoc:javadoc -fae`, which is now clean across all 17 modules; checkstyle passes. Note that bare `./mvnw javadoc:javadoc` still fails, but on dependency resolution rather than javadoc: the goal runs no lifecycle phase, so the reactor jars do not exist, and the project forbids `mvn install`. Prefix it with `package -DskipTests` to run the check. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
1 parent 28cc4f7 commit 594338d

6 files changed

Lines changed: 11 additions & 7 deletions

File tree

fbs-gen/src/main/java/io/github/dfa1/vortex/fbsgen/CodeGen.java

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616
/// - each `enum` becomes a constants holder over its underlying integer type;
1717
/// - each `union` becomes a discriminator-constants holder (NONE = 0, members from 1).
1818
///
19-
/// The wire layout is the standard FlatBuffers binary format — see [FbsTable]/[FbsBuilder].
19+
/// The wire layout is the standard FlatBuffers binary format. The runtime base classes the
20+
/// emitted code extends (`FbsTable`, `FbsMemorySegment`, `FbsBuilder`) live in the generated
21+
/// package `io.github.dfa1.vortex.core.fbs`, which this module does not depend on — it emits
22+
/// their source, so they are named here as text rather than linked.
2023
public final class CodeGen {
2124

2225
/// Prefix applied to every emitted Java class name so the generated wire-format

reader/src/main/java/io/github/dfa1/vortex/reader/array/StructArray.java

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

1111
/// Decoded struct array: holds one [Array] per field, keyed by position.
1212
///
13-
/// Returned by [io.github.dfa1.vortex.encoding.StructEncoding] when decoding a
13+
/// Returned by [io.github.dfa1.vortex.reader.decode.StructEncodingDecoder] when decoding a
1414
/// multi-field `vortex.struct` segment (all columns packed into one flat).
1515
public final class StructArray implements Array {
1616

reader/src/main/java/io/github/dfa1/vortex/reader/decode/ByteBoolEncodingDecoder.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
import java.lang.foreign.ValueLayout;
99

1010
/// Read-only decoder for `vortex.bytebool` — packs the input byte buffer into the
11-
/// bit-packed [BoolArray] layout used by `vortex.bool`.
11+
/// bit-packed [MaterializedBoolArray] layout used by `vortex.bool`.
1212
public final class ByteBoolEncodingDecoder implements EncodingDecoder {
1313

1414
@Override

writer/src/main/java/io/github/dfa1/vortex/writer/Chunk.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
///
77
/// Validates each `put` against the writer's schema:
88
/// - Column name must exist in the schema.
9-
/// - Array type must match the column [DType].
9+
/// - Array type must match the column [io.github.dfa1.vortex.core.model.DType].
1010
/// - Non-nullable columns reject boxed arrays containing `null`.
1111
///
1212
/// All schema columns must be supplied before the consumer returns; all column

writer/src/main/java/io/github/dfa1/vortex/writer/encode/ArrayStats.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
/// sample-encoding probe that biases on leading rows.
1212
///
1313
/// All values are stored as raw 64-bit patterns (`doubleToRawLongBits` for floats,
14-
/// zero-extended unsigned ints for U8/U16/U32). Use [#mostFrequentValueBits()] etc. and
14+
/// zero-extended unsigned ints for U8/U16/U32). Use [#mostFrequentBits()] etc. and
1515
/// reinterpret per ptype as needed.
1616
///
1717
/// @param valueCount number of non-null elements scanned

writer/src/main/java/io/github/dfa1/vortex/writer/encode/NullableData.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,16 @@
33
/// Writer-side carrier for nullable column data: a packed values array paired with a
44
/// per-row validity bitmap.
55
///
6-
/// `values` carries the raw storage in the shape an [Encoding] expects
6+
/// `values` carries the raw storage in the shape an [EncodingEncoder] expects
77
/// (`int[]`, `long[]`, `byte[]`, `double[]`, ...). Null
88
/// positions hold zero-valued placeholders so primitive encoders can compress them
99
/// alongside real data. `validity` has the same logical length: `true`
1010
/// for valid rows, `false` for nulls.
1111
///
1212
/// The writer recognizes this shape and emits the `vortex.masked`
1313
/// wire layout: a non-nullable child (the storage) plus an optional Bool
14-
/// validity child. Readers reconstruct a [io.github.dfa1.vortex.reader.array.MaskedArray].
14+
/// validity child. Readers reconstruct a `MaskedArray` — named as text, not linked, because
15+
/// the writer module does not depend on the reader.
1516
///
1617
/// Invariant: `values` length (or storage row count) matches
1718
/// `validity.length`; placeholders at null positions must be zero so the

0 commit comments

Comments
 (0)