[Cherbot-commit] SF.net SVN: cherbot: [88] trunk/src/net/sf/cherbot/AbstractConnection.java

[<chr...@us...>]

Revision: 88
          http://svn.sourceforge.net/cherbot/?rev=88&view=rev
Author:   christianhujer
Date:     2007-06-20 13:30:02 -0700 (Wed, 20 Jun 2007)

Log Message:
-----------
Improved documentation.

Modified Paths:
--------------
    trunk/src/net/sf/cherbot/AbstractConnection.java

Modified: trunk/src/net/sf/cherbot/AbstractConnection.java
===================================================================
--- trunk/src/net/sf/cherbot/AbstractConnection.java	2007-06-20 20:28:03 UTC (rev 87)
+++ trunk/src/net/sf/cherbot/AbstractConnection.java	2007-06-20 20:30:02 UTC (rev 88)
@@ -77,6 +77,7 @@
     }
 
     /** Establishes this connection.
+     * Implementations of this method must invoke {@link #setSocket(Socket)}.
      * @return The socket created for this connection.
      * @throws IOException in case of connection problems.
      */
@@ -100,7 +101,7 @@
 
     /** Returns whether this connection is established.
      * @return <code>true</code> if this connection is established, otherwise <code>false</code>.
-     * @see java.net.Socket#isConnected()
+     * @see Socket#isConnected()
      */
     public boolean isConnected() {
         return socket != null && socket.isConnected();


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.