Added documentation for new broadcast methods

PhilipRoman · PhilipRoman · commit 135b3c6916cb · 2018-05-25T13:43:47.000+03:00
diff --git a/src/main/java/org/java_websocket/server/WebSocketServer.java b/src/main/java/org/java_websocket/server/WebSocketServer.java
@@ -812,6 +812,10 @@ public void broadcast(byte[] data) {
 		broadcast( data, connections );
 	}
 
+	/**
+	 * Send a ByteBuffer to all connected endpoints
+	 * @param data the data to send to the endpoints
+	 */
 	public void broadcast(ByteBuffer data) {
 		broadcast(data, connections);
 	}
@@ -845,6 +849,11 @@ public void broadcast(byte[] data, Collection<WebSocket> clients) {
 		}
 	}
 
+	/**
+	 * Send a ByteBuffer to a specific collection of websocket connections
+	 * @param data the data to send to the endpoints
+	 * @param clients a collection of endpoints to whom the text has to be send
+	 */
 	public void broadcast(ByteBuffer data, Collection<WebSocket> clients) {
 		if (data == null || clients == null) {
 			throw new IllegalArgumentException();

Original file line number	Diff line number	Diff line change
`@@ -812,6 +812,10 @@ public void broadcast(byte[] data) {`
`812`	`812`	`broadcast( data, connections );`
`813`	`813`	`}`
`814`	`814`
	`815`	`+ /**`
	`816`	`+ * Send a ByteBuffer to all connected endpoints`
	`817`	`+ * @param data the data to send to the endpoints`
	`818`	`+ */`
`815`	`819`	`public void broadcast(ByteBuffer data) {`
`816`	`820`	`broadcast(data, connections);`
`817`	`821`	`}`
`@@ -845,6 +849,11 @@ public void broadcast(byte[] data, Collection<WebSocket> clients) {`
`845`	`849`	`}`
`846`	`850`	`}`
`847`	`851`
	`852`	`+ /**`
	`853`	`+ * Send a ByteBuffer to a specific collection of websocket connections`
	`854`	`+ * @param data the data to send to the endpoints`
	`855`	`+ * @param clients a collection of endpoints to whom the text has to be send`
	`856`	`+ */`
`848`	`857`	`public void broadcast(ByteBuffer data, Collection<WebSocket> clients) {`
`849`	`858`	`if (data == null \|\| clients == null) {`
`850`	`859`	`throw new IllegalArgumentException();`