Skip to content

Javadoc overhaul for the Method-Writer stack #1121

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

Conversation

peter-lawrey
Copy link
Member

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

Pull Request – Javadoc overhaul for the Method-Writer stack (#1110)

The Method-Writer code-path (proxy generation, invocation handlers, builders and helpers) is one of Chronicle Wire’s most sophisticated areas, but its documentation lagged behind the implementation:

  • Several public classes lacked any contract-level comment.
  • Internal helpers had misleading or redundant remarks (“This was a lambda…”).
  • IDE quick-docs showed boiler-plate placeholders instead of useful guidance.

Cleaning this up vastly improves discoverability for users building fluent APIs and makes maintenance easier for the team.

What changed?

Area Classes touched Highlights
Invocation layer AbstractMethodWriterInvocationHandler, BinaryMethodWriterInvocationHandler, TextMethodWriterInvocationHandler, MethodWriterInvocationHandlerSupplier, ParameterHolderSequenceWriter • Clarified record-history, method-ID and generic-event semantics
• Documented caching strategy and thread-safety behaviour
Proxy generation (v1 & v2) GenerateMethodWriter, GenerateMethodWriter2, MethodWriterClassNameGenerator • Added end-to-end class/field/method docs explaining name mangling, template use, hash logic & fallbacks
• Removed verbose “what this method returns” boiler-plate and replaced with focused info
Builder & API contracts VanillaMethodWriterBuilder, MethodWriter, MethodWriterValidationException • Detailed fluent options, fallback paths, and error cases
• Linked to public entry points (MarshallableOut#methodWriter…)
Validation & Exceptions MethodWriterValidationException • Now states why fallback to reflection is not performed
Misc. helpers MethodWriterClassNameGenerator • Explained naming algorithm, hash converter, and length guard

comment-only — absolutely no byte-code or runtime behaviour change.

@peter-lawrey peter-lawrey changed the title Adv/14 method writer Javadoc overhaul for the **Method-Writer** stack Jun 1, 2025
@peter-lawrey peter-lawrey changed the title Javadoc overhaul for the **Method-Writer** stack Javadoc overhaul for the Method-Writer stack Jun 1, 2025
@peter-lawrey peter-lawrey requested a review from tgd June 3, 2025 11:25
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