svn commit: r1357423 - in /hama/trunk/core/src/main/java/org/apache/hama/util: BSPNetUtils.java ClusterUtil.java VersionInfo.java

[tommaso]

Author: tommaso
Date: Wed Jul  4 21:44:08 2012
New Revision: 1357423

URL: http://svn.apache.org/viewvc?rev=1357423&view=rev
Log:
[HAMA-572] - fixing javadoc)

Modified:
    hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java
    hama/trunk/core/src/main/java/org/apache/hama/util/ClusterUtil.java
    hama/trunk/core/src/main/java/org/apache/hama/util/VersionInfo.java

Modified: hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java
URL: 
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java?rev=1357423&r1=1357422&r2=1357423&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java 
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/util/BSPNetUtils.java Wed Jul 
 4 21:44:08 2012
@@ -17,17 +17,13 @@
  */
 package org.apache.hama.util;
 
-import java.io.IOException;
-import java.net.DatagramSocket;
-import java.net.InetAddress;
-import java.net.InetSocketAddress;
-import java.net.ServerSocket;
-import java.net.UnknownHostException;
-import java.util.NoSuchElementException;
-
 import org.apache.hama.Constants;
 import org.apache.mina.util.AvailablePortFinder;
 
+import java.io.IOException;
+import java.net.*;
+import java.util.NoSuchElementException;
+
 /**
  * NetUtils for our needs.
  */
@@ -37,7 +33,7 @@ public class BSPNetUtils {
   /**
    * Gets the canonical hostname of this machine.
    * 
-   * @return
+   * @return String representing host canonical host name
    * @throws UnknownHostException
    */
   public static String getCanonicalHostname() throws UnknownHostException {
@@ -71,8 +67,8 @@ public class BSPNetUtils {
    * Gets a new InetSocketAddress from the given peerName. peerName must 
contain
    * a colon to distinct between host and port.
    * 
-   * @param peerName
-   * @return
+   * @param peerName the name as a String of the BSP peer to get the address 
from
+   * @return the InetSocketAddress of the given BSP peer
    */
   public static InetSocketAddress getAddress(String peerName) {
     String[] peerAddrParts = peerName.split(":");

Modified: hama/trunk/core/src/main/java/org/apache/hama/util/ClusterUtil.java
URL: 
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/util/ClusterUtil.java?rev=1357423&r1=1357422&r2=1357423&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/util/ClusterUtil.java 
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/util/ClusterUtil.java Wed Jul 
 4 21:44:08 2012
@@ -17,9 +17,6 @@
  */
 package org.apache.hama.util;
 
-import java.io.IOException;
-import java.util.List;
-
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 import org.apache.hadoop.conf.Configuration;
@@ -27,6 +24,9 @@ import org.apache.hama.HamaConfiguration
 import org.apache.hama.bsp.BSPMaster;
 import org.apache.hama.bsp.GroomServer;
 
+import java.io.IOException;
+import java.util.List;
+
 public class ClusterUtil {
   private static final Log LOG = LogFactory.getLog(ClusterUtil.class);
   
@@ -86,9 +86,9 @@ public class ClusterUtil {
 
   /**
    * Start the cluster.
-   * @param m
-   * @param conf 
-   * @param groomservers
+   * @param m the BSP master
+   * @param conf cluster configuration to be used
+   * @param groomservers list of threads holding groom servers
    * @return Address to use contacting master.
    * @throws InterruptedException 
    * @throws IOException 

Modified: hama/trunk/core/src/main/java/org/apache/hama/util/VersionInfo.java
URL: 
http://svn.apache.org/viewvc/hama/trunk/core/src/main/java/org/apache/hama/util/VersionInfo.java?rev=1357423&r1=1357422&r2=1357423&view=diff
==============================================================================
--- hama/trunk/core/src/main/java/org/apache/hama/util/VersionInfo.java 
(original)
+++ hama/trunk/core/src/main/java/org/apache/hama/util/VersionInfo.java Wed Jul 
 4 21:44:08 2012
@@ -40,7 +40,7 @@ public class VersionInfo {
 
   /**
    * Get the meta-data for the Hama package.
-   * @return
+   * @return the current package
    */
   static Package getPackage() {
     return myPackage;