[usocket-cvs] r63 - usocket/trunk

[ehuelsmann at common-lisp.net]

Author: ehuelsmann
Date: Wed Feb  8 14:47:18 2006
New Revision: 63

Modified:
   usocket/trunk/usocket.lisp
Log:
Move function documentation out of the backend file.

Modified: usocket/trunk/usocket.lisp
==============================================================================
--- usocket/trunk/usocket.lisp	(original)
+++ usocket/trunk/usocket.lisp	Wed Feb  8 14:47:18 2006
@@ -139,3 +139,15 @@
                 (host-to-hbo (get-host-by-name host)))))
     ((vector t 4) (host-byte-order host))
     (integer host)))
+
+;;
+;; Setting of documentation for backend defined functions
+;;
+
+(setf (documentation 'socket-connect 'function)
+      "Connect to `host' on `port'.  `host' is assumed to be a string of
+an IP address represented in vector notation, such as #(192 168 1 1).
+`port' is assumed to be an integer.
+
+Returns a usocket object.")
+