Skip to content

Comprehensive Javadoc Refresh for Custom Wires #1109

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 11 commits into
base: adv/docs
Choose a base branch
from

Conversation

peter-lawrey
Copy link
Member

@peter-lawrey peter-lawrey commented Jun 1, 2025

The wire module’s public-facing documentation had drifted behind the codebase, leaving gaps, outdated descriptions and inconsistent style. Clear, accurate Javadoc is essential for:

  • Onboarding & maintenance – newcomers can understand design intentions without having to delve into the code.
  • Tooling – IDE quick-docs and generated site docs inherit these comments.
  • API stability – well-defined contracts make it obvious what is (and is not) part of the public API surface.

What changed?

Commit Class / Area Key improvements
76866f6 / #1105 RawWire End-to-end rewrite: focuses on metadata-free layout, read/write caveats, constructor params, inner RawValue* docs.
9d4f7d6 / #1106 CSVWire Added header-row semantics, escaping rules, constructor factories, and detailed ValueIn/Out behaviour.
50b2b84 / #1107 QueryWire Describes URL-query grammar, stop-char testers, unsupported operations, and value writer semantics.
0e54b10 / #1101 HashWire Positions class as hashing-only WireOut, explains mixing constants, thread-local usage and every ValueOut branch.
68f76f1 / #1102 InputStreamToWire Documents length-prefixed framing, buffer lifecycle and error handling.
3846c4a / #1103 WireToOutputStream Mirrors the above for output: explains framing, buffer reuse and stream ownership.
85500a8 / #1104 WireObjectOutput Adds per-method mapping notes from ObjectOutputValueOut, clarifies no-op methods.
ae32574 / #1108 WireObjectInput Trims boilerplate, adds targeted explanations, documents unsupported operations.

Net diff: ~ +540 / -190 lines, 100 % comment-only – zero bytecode or functional changes.

@peter-lawrey peter-lawrey changed the title Adv/custom wires Comprehensive Javadoc Refresh for Custom Wires Jun 1, 2025
@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:26
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant