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

Clean up Javadoc #253

Merged
merged 2 commits into from
Jun 27, 2018
Merged

Clean up Javadoc #253

merged 2 commits into from
Jun 27, 2018

Conversation

markt-asf
Copy link
Contributor

Fix #252

* provider class uses the
* <a href="http://docs.oracle.com/javase/7/docs/api/java/util/ServiceLoader.html">ServiceLoader</a> to load an
* implementation of ContainerProvider. Specifically, the fully qualified class name of the container implementation of
* ContainerProvider must be listed in the META-INF/services/javax.websocket.ContainerProvider file in the
Copy link
Contributor

Choose a reason for hiding this comment

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

Enclose filenames in quotes. aka "META-INF/services/javax.websocket.ContainerProvider"

Example of this javdoc style: https://docs.oracle.com/javase/7/docs/api/java/util/logging/LogManager.html

* that is not {@code null}.
* Obtain a new instance of a WebSocketContainer. The method looks for the ContainerProvider implementation class in
* the order listed in the META-INF/services/javax.websocket.ContainerProvider file, returning the first
* WebSocketContainer implementation from the ContainerProvider implementation that is not {@code null}.
Copy link
Contributor

Choose a reason for hiding this comment

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

Enclose filenames in quotes. aka "META-INF/services/javax.websocket.ContainerProvider"

Copy link
Contributor

@joakime joakime left a comment

Choose a reason for hiding this comment

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

LGTM

@markt-asf markt-asf merged commit 3860eef into jakartaee:master Jun 27, 2018
@markt-asf markt-asf deleted the issue-252 branch June 27, 2018 12:17
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.

2 participants