Javadoc for Core Wire API & Base Classes #1020
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
✨ 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.).{@code …}
usageLog-spew removal – deleted a stray debug
System.err.println
in
AbstractWire.endOfWire
.Commit map
AbstractWire
.SourceContext
Javadoc (#1017)MarshallableOut
Javadoc (#1016)ReadAnyWire
lazy detection flow.AbstractWire
Javadoc (#1014)Wire
Javadoc (#1013)WireOut
Javadoc (#1012)WireIn
Javadoc (#1011)WireCommon
Javadoc (#1009)Wire
interface Javadoc (#1019)Impact & compatibility