NetworkSocketClosing: add missing javadoc

diff --git a/src/uk/ac/ntu/n0521366/wsyd/libs/net/NetworkSocketClosing.java b/src/uk/ac/ntu/n0521366/wsyd/libs/net/NetworkSocketClosing.java
index 19076a9..649b6cf 100644 (file)
--- a/src/uk/ac/ntu/n0521366/wsyd/libs/net/NetworkSocketClosing.java
+++ b/src/uk/ac/ntu/n0521366/wsyd/libs/net/NetworkSocketClosing.java
@@ -1,7 +1,7 @@
 /*
  * The MIT License
  *
- * Copyright 2015 eddie.
+ * Copyright 2015 Eddie Berrisford-Lynch <dev@fun2be.me>.
  *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
@@ -24,8 +24,10 @@
 package uk.ac.ntu.n0521366.wsyd.libs.net;
 
 /**
- *
- * @author eddie
+ * Implemented by objects that want to know when a (TCP) network socket is to be closed.
+ * 
+ * @see uk.ac.ntu.n0521366.wsyd.libs.net.NetworkStreamManager
+ * @author Eddie Berrisford-Lynch <dev@fun2be.me>
  */
 public interface NetworkSocketClosing {
     /**
@@ -34,7 +36,7 @@ public interface NetworkSocketClosing {
      * Parent will remove stream from its list and stream shall proceed to close.
      * 
      * @param key
-     * @return 
+     * @return true if the socket can be closed safely (no references remain)
      */
     public boolean canCloseSocket(long key);
 }