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

Added javadocs for injection and extensions #171

Merged
merged 2 commits into from Oct 17, 2018

Conversation

jroper
Copy link
Contributor

@jroper jroper commented Jul 18, 2018

This documentation could have potentially saved me hours when I was first writing an Arquillian extension - you assume the injection framework is going to work like any other, where you bind components either using annotations or some module API (which is what the loadable extension API looks like with its service registration method), and even though through reverse engineering I'd worked out that components could be provided by InstanceProducer.set(), it never occurred to me that that was an API that I was supposed to use, I thought that was an internal implementation detail that Arquillian would invoke, for example, for each service registered by a loadable extension. So I spent hours scratching my head trying to understand why the services I had registered weren't being injected, and trying to find the code that was meant to register each service with an InstanceProducer (which of course didn't exist).

Copy link
Member

@bartoszmajsak bartoszmajsak left a comment

Choose a reason for hiding this comment

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

Thank you very much @jroper for improving the docs and apologies this contribution came through the painful path. 🥇

@bartoszmajsak bartoszmajsak merged commit 6d949c5 into arquillian:master Oct 17, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants