Skip to content

Javadoc for Core Wire API & Base Classes #1020

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 2 commits into
base: adv/docs
Choose a base branch
from

Conversation

peter-lawrey
Copy link
Member

@peter-lawrey peter-lawrey commented May 30, 2025

✨ What’s inside this PR

A spring-clean of Chronicle Wire’s public API documentation plus one tiny code tidy-up.

  • Fresh, developer-focused Javadoc across the core API surface
    (Wire, WireIn, WireOut, WireCommon, MarshallableOut, SourceContext,
    ReadAnyWire, AbstractWire, etc.).

    • Clearer intent sentences in the first line (good for IDE pop-ups)
    • Consistent parameter / return wording and {@code …} usage
    • Extra context & examples where our users have stumbled before
    • Explicit notes on threading, locking, padding and header semantics
    • Removal of outdated remarks (RAW wire, old queue tricks…)
  • Log-spew removal – deleted a stray debug System.err.println
    in AbstractWire.endOfWire.


Commit map

Commit Message Summary
01/11 Create the branch Drops the redundant blank log line in AbstractWire.
02/11 Clarify SourceContext Javadoc (#1017) Modern, concise description + param docs.
03/11 Improve MarshallableOut Javadoc (#1016) Full rewrite; adds examples & thread-safety notes.
04/11 Clarify acquisition Javadoc (#1015) Better explanation of ReadAnyWire lazy detection flow.
05/11 Improve AbstractWire Javadoc (#1014) 100-line expansion covering every tricky internal field.
06/11 Clarify Wire Javadoc (#1013) First-line summary & method docs.
07/11 Enhance WireOut Javadoc (#1012) Consistent English, new examples, tightened throws.
08/11 Improve WireIn Javadoc (#1011) Similar pass for read-side API.
09/11 (no diff – squashed into 08/11)
10/11 Improve WireCommon Javadoc (#1009) Clarifies padding, parent, reference factories.
11/11 Improve Wire interface Javadoc (#1019) Follow-up tweaks & typo fixes.

Impact & compatibility

  • Code behaviour: unchanged – docs only, plus removal of one unused log line.
  • Binary/API compatibility: safe – no signatures touched.
  • Generated site: Javadoc HTML will update automatically on next release.

@peter-lawrey peter-lawrey changed the title Adv/01 core api Javadoc for Core Wire API & Base Classes May 30, 2025
@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:59
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