Add examples trait support #995
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
JordonPhillips
force-pushed
the
examples-trait
branch
3 times, most recently
from
691a904 to
ad54ad7
Compare
This adds a generator that writes out shape initializers given their value as a node. This is primarily intended for examples, but could be used for other purposes.
This adds support for the examples trait to javadoc generation for clients.
JordonPhillips
force-pushed
the
examples-trait
branch
from
ad54ad7 to
affaaaa
Compare
mtdowling
reviewed
Dec 19, 2025
| var expected = """ | ||
| * <h4>Examples</h4> | ||
| * <h5>Basic Example</h5> | ||
| * <pre> |
mtdowling
approved these changes
Dec 19, 2025
adwsingh
reviewed
Dec 20, 2025
| return false; | ||
| } | ||
| try { | ||
| Base64.getDecoder().decode(value.getBytes(StandardCharsets.UTF_8)); |
Contributor
There was a problem hiding this comment.
Suggested change
| Base64.getDecoder().decode(value.getBytes(StandardCharsets.UTF_8)); | |
| Base64.getDecoder().decode(value); |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This adds support for generating examples based on the examples trait. It also adds a general ability to generate code that initializes shapes based on a
Nodevalue as translated to Java code.Note that the deserialize interface isn't used in this because the intent is to generate something that's naturally readable. Writing out the node and calling deserilize on it wouldn't be very readable, and wouldn't work on things that don't have the deserialize method.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.