Skip to content

Commit

Permalink
Improving javadoc
Browse files Browse the repository at this point in the history
Signed-off-by: Joakim Erdfelt <[email protected]>
  • Loading branch information
joakime committed Sep 20, 2023
1 parent 80e2d4d commit 2311ac5
Showing 1 changed file with 17 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,13 @@ public WebSocketClient()
}

/**
* Instantiate a WebSocketClient using HttpClient for defaults
* <p>
* Instantiate a WebSocketClient.
* </p>
*
* <p>
* HTTP behaviors of the WebSocket upgrade are taken from the HttpClient configuration.
* </p>
*
* @param httpClient the HttpClient to base internal defaults off of
*/
Expand All @@ -95,10 +101,17 @@ public WebSocketClient(HttpClient httpClient)
}

/**
* Instantiate a WebSocketClient using HttpClient for defaults
* <p>
* Instantiate a WebSocketClient.
* </p>
*
* @param httpClient the HttpClient to base internal defaults off of
* @param webSocketComponents the configured WebSocketComponents to use
* <p>
* HTTP behaviors of the WebSocket upgrade are taken from the {@link HttpClient} configuration.
* WebSocket behaviors are taken from the {@link WebSocketComponents} configuration.
* </p>
*
* @param httpClient the HttpClient to use for the HTTP behaviors of WebSocket upgrade
* @param webSocketComponents the WebSocketComponents to use for WebSocket behaviors
*/
public WebSocketClient(HttpClient httpClient, WebSocketComponents webSocketComponents)
{
Expand Down

0 comments on commit 2311ac5

Please sign in to comment.