2003-12-21 Michael Koch <konqueror@gmx.de>

	* gnu/java/net/PlainDatagramSocketImpl.java
	(mcastGrp): Added documentation.


git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@74896 138bc75d-0d04-0410-961f-82ee72b054a4

1 files changed, 15 insertions, 2 deletions

diff --git a/libjava/gnu/java/net/PlainDatagramSocketImpl.java b/libjava/gnu/java/net/PlainDatagramSocketImpl.java
index 9f710d37b4c..a3146518783 100644
--- a/libjava/gnu/java/net/PlainDatagramSocketImpl.java
+++ b/libjava/gnu/java/net/PlainDatagramSocketImpl.java
@@ -211,8 +211,21 @@ public final class PlainDatagramSocketImpl extends DatagramSocketImpl
    */
   public native Object getOption(int optID) throws SocketException;
   
-  private native void mcastGrp(InetAddress inetaddr, NetworkInterface netIf,
-		               boolean join) throws IOException;
+  /**
+   * Joins or leaves a broadcasting group on a given network interface.
+   * If the network interface is <code>null</code> the group is join/left on
+   * all locale network interfaces.
+   * 
+   * @param inetAddr The broadcast address.
+   * @param netIf The network interface to join the group on.
+   * @param join True to join a broadcasting group, fals to leave it.
+   *
+   * @exception IOException If an error occurs.
+   */
+  private native void mcastGrp(InetAddress inetAddr,
+		  	       NetworkInterface netIf,
+		               boolean join)
+    throws IOException;
 
   /**
    * Closes the socket