Refactor trait codegen javadoc integration to correctly support member documentation #2265
Conversation
This file contains 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
kstich
requested changes
Apr 30, 2024
...codegen/src/main/java/software/amazon/smithy/traitcodegen/generators/EnumShapeGenerator.java
Outdated
Show resolved
Hide resolved
...ava/software/amazon/smithy/traitcodegen/integrations/javadoc/JavadocInjectorInterceptor.java
Outdated
Show resolved
Hide resolved
...ava/software/amazon/smithy/traitcodegen/integrations/javadoc/JavadocInjectorInterceptor.java
Outdated
Show resolved
Hide resolved
...ava/software/amazon/smithy/traitcodegen/integrations/javadoc/SmithyGeneratedInterceptor.java
Outdated
Show resolved
Hide resolved
...ait-codegen/src/main/java/software/amazon/smithy/traitcodegen/writer/TraitCodegenWriter.java
Outdated
Show resolved
Hide resolved
Co-authored-by: Kevin Stich <kevin@kstich.com>
kstich
approved these changes
Apr 30, 2024
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.
Background
Refactors the trait codegen Javadoc integration to use a new approach to adding javadocs to both clean up the integration and to correctly support documentation on all members and enum variants.
In this updated approach empty Javadoc sections are first injected for all getters, classes, and enum variants. Interceptors can then populate the Javadocs section with text based on the presence of documentation traits. Finally, the core integration formats any javadoc sections with text as Java doc comments and discards any empty Javadoc sections.
Testing
Adds new suite of more comprehensive tests for smithy documentation traits.
Links
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.