Skip to content

Javadoc text yaml wire v2 #1076

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

Javadoc text yaml wire v2 #1076

wants to merge 14 commits into from

Conversation

peter-lawrey
Copy link
Member

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

The net effect is that the most frequently used text/YAML classes now ship with concise, accurate JavaDocs, while all method signatures and bytecode remain unchanged.

What actually lands

Area Key classes / files Outcome
Core text-wire docs TextWire, inner TextValueIn Fresh Javadoc on parsing, strict-mode, file helpers, field reading, stop-char testers, padding & document markers.
YAML wire docs YamlWire, YamlWireOut, inner YamlValueOut Clarifies YAML tags, anchor/alias handling, timestamp comments, quoting/escaping logic and marshalling helpers.
Tokenisation & helpers YamlTokeniser, YamlToken, TextStopCharTesters, Quotes End-to-end explanation of token flow, context stack, literal blocks, and the stop-char utilities behind them.
Utilities YamlLogging, YamlKeys Describes runtime logging switches and offset-tracking used by the tokeniser.
Minor fixes WireDumper, Wires, hasMetaDataPrefix() (TextWire) Small clarifications / missing tags.

@peter-lawrey peter-lawrey force-pushed the adv/07-Text-YamlWire branch from e2efbc6 to 77d2dae Compare June 2, 2025 09:19
@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