improve extension API documentation and resolve some open questions#520
Merged
Ladicek merged 1 commit intojakartaee:masterfrom Sep 13, 2021
Merged
improve extension API documentation and resolve some open questions#520Ladicek merged 1 commit intojakartaee:masterfrom
Ladicek merged 1 commit intojakartaee:masterfrom
Conversation
Member
Author
|
Sorry for not getting to this sooner, I was occupied elsewhere. This adds documentation to the last undocumented part of the extension API -- synthetic components. This means that the extension API should now be fully documented -- it doesn't mean that all TODOs are gone, but we're getting there :-) |
graemerocher
requested changes
Sep 10, 2021
Contributor
graemerocher
left a comment
There was a problem hiding this comment.
Looks fine, just one small typo I noticed
api/src/main/java/jakarta/enterprise/inject/build/compatible/spi/SubtypesOf.java
Outdated
Show resolved
Hide resolved
- documentation added for synthetic beans and observers; this was
the last place where proper documentation was missing
- `DeclarationConfig` is no longer generic and `{Class,Method,Field}Config`
explicitly override the configuration methods, so that users don't have to
declare a useless type argument when using `DeclarationConfig`
- `AnnotationMember.as*` methods don't perform type conversions
- added `MethodInfo.isConstructor` to distinguish constructors
from regular methods
1222e32 to
6aafb8a
Compare
manovotn
approved these changes
Sep 13, 2021
graemerocher
approved these changes
Sep 13, 2021
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
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.
the last place where proper documentation was missing
DeclarationConfigis no longer generic and{Class,Method,Field}Configexplicitly override the configuration methods, so that users don't have to
declare a useless type argument when using
DeclarationConfigAnnotationMember.as*methods don't perform type conversionsMethodInfo.isConstructorto distinguish constructorsfrom regular methods