ServiceAddressMap: add missing javadoc
authorEddie <dev@fun2be.me>
Sat, 6 Jun 2015 08:35:01 +0000 (09:35 +0100)
committerEddie <dev@fun2be.me>
Sat, 6 Jun 2015 09:36:30 +0000 (10:36 +0100)
src/uk/ac/ntu/n0521366/wsyd/libs/net/ServiceAddressMap.java

index 5a1e1f6..d27183a 100644 (file)
@@ -47,12 +47,18 @@ public class ServiceAddressMap {
      */
     public static class LastSeenHost {
         /**
-         * State of a record:
-         * 
-         * STATIC = was manually entered and should not be removed
-         * DYNAMIC = was discovered via multicast announcement or new connection and can be removed
+         * State of a record.
          */
-        public static enum STATE {STATIC, DYNAMIC}
+        public static enum STATE {
+            /**
+             * was manually entered and should not be removed
+             */
+            STATIC,
+            /**
+             * was discovered via multicast announcement or new connection and can be removed
+             */
+            DYNAMIC
+        }
         
         public final STATE state;
         public final long timeInMillis;
@@ -204,8 +210,8 @@ public class ServiceAddressMap {
     
     /**
      * 
-     * @param service
-     * @return 
+     * @param service the service required
+     * @return true if service is in the map
      */
     public boolean containsService(String service) {
         return this._serviceToAddressMap.containsKey(service);