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

Missing documentation for ServiceLoader option for loading Providers #708

Open
lukasj opened this issue Feb 15, 2024 · 1 comment · May be fixed by #726
Open

Missing documentation for ServiceLoader option for loading Providers #708

lukasj opened this issue Feb 15, 2024 · 1 comment · May be fixed by #726

Comments

@lukasj
Copy link
Contributor

lukasj commented Feb 15, 2024

Describe the bug
A documentation at https://jakarta.ee/specifications/mail/2.1/jakarta-mail-spec-2.1#a240 does not mention the option of ServiceLoader to load a Provider. I see that Angus Mail is RI of the specification so this could be an issue of the specification itself. In this case my question is where I can contribute this proposal to the specifaction.
Until the specification will describe the details it would be a "workaround" to extend the java doc of the Provider at https://jakarta.ee/specifications/mail/2.1/apidocs/jakarta.mail/jakarta/mail/provider to give the details of this option.
Actually the ServiceLoader option was implemented at javaee/javamail@c4e604d five years ago.

To Reproduce
Look at the documentation and they are missing to mention this option.
https://jakarta.ee/specifications/mail/2.1/jakarta-mail-spec-2.1#a240
https://jakarta.ee/specifications/mail/2.1/apidocs/jakarta.mail/jakarta/mail/provider

Expected behavior
Add the ServiceLoader option to the documentation both in the specification and in the java doc of Provider

from eclipse-ee4j/angus-mail#112

@verhasi
Copy link

verhasi commented Mar 24, 2024

Hi @lukasj

Thank you for handling my request in the Angus mail project and moving it here, to the right place. Even I have added the missing Javadoc, it is still not clear how to contribute to the change of the specification.

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 a pull request may close this issue.

2 participants