Skip to content
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

improve extension API documentation and resolve some open questions #520

Merged
merged 1 commit into from
Sep 13, 2021

Conversation

Ladicek
Copy link
Contributor

@Ladicek Ladicek commented Sep 10, 2021

  • 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

@Ladicek
Copy link
Contributor Author

Ladicek commented Sep 10, 2021

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 :-)

Copy link
Contributor

@graemerocher graemerocher left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks fine, just one small typo I noticed

- 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
@Ladicek Ladicek merged commit fd159ab into jakartaee:master Sep 13, 2021
@Ladicek Ladicek deleted the api-improvements branch September 13, 2021 12:15
@Ladicek Ladicek added Lite Related to CDI Lite lite-extension-api Issues related to CDI Lite extension API proposal labels Oct 18, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Lite Related to CDI Lite lite-extension-api Issues related to CDI Lite extension API proposal
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants