-
Notifications
You must be signed in to change notification settings - Fork 131
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
peter-lawrey
wants to merge
17
commits into
adv/docs
Choose a base branch
from
adv/14-method-writer
base: adv/docs
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…WriterInvocationHandler
…onicle-Wire into adv/14-method-writer
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
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:
Cleaning this up vastly improves discoverability for users building fluent APIs and makes maintenance easier for the team.
What changed?
AbstractMethodWriterInvocationHandler
,BinaryMethodWriterInvocationHandler
,TextMethodWriterInvocationHandler
,MethodWriterInvocationHandlerSupplier
,ParameterHolderSequenceWriter
• Documented caching strategy and thread-safety behaviour
GenerateMethodWriter
,GenerateMethodWriter2
,MethodWriterClassNameGenerator
• Removed verbose “what this method returns” boiler-plate and replaced with focused info
VanillaMethodWriterBuilder
,MethodWriter
,MethodWriterValidationException
• Linked to public entry points (
MarshallableOut#methodWriter…
)MethodWriterValidationException
MethodWriterClassNameGenerator
comment-only — absolutely no byte-code or runtime behaviour change.