search

jakartaee / mail-api

Jakarta Mail Specification project
https://jakartaee.github.io/mail-api
Other
240 stars 100 forks source link

Missing documentation for ServiceLoader option for loading Providers #708

Open lukasj opened 4 months ago

lukasj commented 4 months ago

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 https://github.com/javaee/javamail/commit/c4e604d528dfe31355fa10484846b85555a3d200 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 https://github.com/eclipse-ee4j/angus-mail/issues/112

verhasi commented 3 months ago

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.