Add documentation

Author: phischu

libraries/common/io/network.effekt

@@ -5,31 +5,39 @@ import bytearray
 import io/error
 
 
-/// A tcp handle. Should not be inspected.
+/// A TCP handle. Should not be inspected.
 type Connection = Int
 
-def connect(host: String, port: Int): Connection / Exception[IOError] =
-  internal::checkResult(internal::connect(host, port))
-
+/// Reads data from a TCP connection into a buffer at the given offset.
 def read(handle: Connection, buffer: ByteArray, offset: Int, size: Int): Int / Exception[IOError] =
   internal::checkResult(internal::read(handle, buffer, offset, size))
 
+/// Writes data from a buffer at the given offset to a TCP connection.
 def write(handle: Connection, buffer: ByteArray, offset: Int, size: Int): Int / Exception[IOError] =
   internal::checkResult(internal::write(handle, buffer, offset, size))
 
+/// Establishes a TCP connection to the specified host and port.
+def connect(host: String, port: Int): Connection / Exception[IOError] =
+  internal::checkResult(internal::connect(host, port))
+
+/// Closes a TCP connection and releases associated resources.
 def close(handle: Connection): Unit =
   internal::close(handle)
 
-/// A tcp listener. Should not be inspected.
+/// A TCP listener. Should not be inspected.
 type Listener = Int
 
+/// Creates a TCP listener bound to the specified host and port.
 def bind(host: String, port: Int): Listener / Exception[IOError] =
   internal::checkResult(internal::bind(host, port))
 
+/// Starts listening for incoming connections and handles them with the provided handler function.
+/// Runs until `shutdown` is called on this `Listener`.
 def listen(listener: Listener, handler: Connection => Unit at {io, async, global}): Unit / Exception[IOError] = {
   internal::checkResult(internal::listen(listener, handler)); ()
 }
 
+/// Stops a TCP listener and releases associated resources.
 def shutdown(listener: Listener): Unit =
   internal::shutdown(listener)