[jboss-jira] [JBoss JIRA] (JBEE-155) Javadoc for WebSocketContainer.connectToServer mentions ServerEndpoint instead of ClientEndpoint

[Ron Šmeral (JIRA)]

    [ https://issues.jboss.org/browse/JBEE-155?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12971353#comment-12971353 ] 

Ron Šmeral commented on JBEE-155:
---------------------------------

Filed upstream: https://java.net/jira/browse/WEBSOCKET_SDK-6, since the org.jboss.spec.javax.websocket API seems to be copied from there.

> Javadoc for WebSocketContainer.connectToServer mentions ServerEndpoint instead of ClientEndpoint
> ------------------------------------------------------------------------------------------------
>
>                 Key: JBEE-155
>                 URL: https://issues.jboss.org/browse/JBEE-155
>             Project: JBoss JavaEE Spec APIs
>          Issue Type: Bug
>          Components: jboss-websocket-api
>    Affects Versions: JavaEE 7 Spec APIs 1.0.0.Final
>            Reporter: Ron Šmeral
>            Assignee: Shelly McGowan
>
> In {{javax.websocket.WebSocketContainer}}, the javadoc for two connectToServer method signatures contains an incorrect statement:
> {{connectToServer(Object annotatedEndpointInstance, URI path)}}
> {{connectToServer(Class<?> annotatedEndpointClass, URI path)}}
> {quote}
> The supplied object must be a class decorated with the class level \{@link javax.websocket.server.*ServerEndpoint*\} annotation.
> {quote}
> which should point to {{javax.websocket.ClientEndpoint}} instead of the ServerEndpoint.
> Also, in case of {{connectToServer(Object annotatedEndpointInstance, URI path)}}, that sentence should read _...supplied object must be *an instance of* a class..._



--
This message was sent by Atlassian JIRA
(v6.2.3#6260)