Skip to content

Javadoc Serialization Strategy & WireMarshaller #1046

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 May 30, 2025

A housekeeping sweep across serialization-strategy infrastructure and the core marshaller

Area Change Rationale
API Docs Re-wrote/expanded Javadoc for:
SerializationStrategy + the SerializationStrategies enum
ScalarStrategy
WireMarshaller, FieldAccess, and the “unexpected field” marshaller
SerializationStrategies nested wrappers (Array/PrimArray/Demarshallable).
* Clearer contracts and type expectations * Links to related types * Added bracket-type semantics * Marked deprecations & removal schedules
Internal comments & tidy-ups • Added missing @return / @param docs
• Removed outdated references (DeltaWire, legacy flags)
• Consistent first-line summary sentences
Easier onboarding; IDE hovers are now useful.

Breakdown by commit

Commit Message Highlight
1/8 Create branch make ordinal field final
2/8 Improve SerializationStrategy Javadoc (#1039) new param/return docs, bracket-type clarifications
3/8 Improve javadoc for SerializationStrategies (#1040) each enum constant now fully documented
4/8 Improve Javadoc in ScalarStrategy (#1041) explained builder helpers, NONE bracket type
5/8 Improve javadoc for WireMarshaller (#1042) overview, constructor notes, leaf/default logic
6/8 Further WireMarshaller docs (#1043) added per-method explanations
7/8 Improve javadoc for FieldAccess (#1045) covered every nested accessor class
8/8 Improve Javadoc for unexpected field marshaller (#1044) explained custom flow when unexpectedField() is overridden

@peter-lawrey peter-lawrey force-pushed the adv/04-serialization branch from 0ae491a to 1f0d929 Compare June 2, 2025 09:21
@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:27
* Create branch

* Improve WireMarshaller javadoc
* Create branch

* Improve Javadoc in ScalarStrategy
* Create branch

* Improve javadoc for SerializationStrategies
* Create branch

* Improve javadoc for FieldAccess
* Create branch

* Improve Javadoc for unexpected field marshaller
* Create branch

* Improve Javadoc for unexpected field marshaller
* Create branch

* Improve javadoc for YamlTokeniser
* Create branch

* Improve WireMarshaller javadoc
* Create branch

* Improve javadoc for WireMarshaller
* Create branch

* Improve SerializationStrategy javadoc
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