Begin socket docs

1 files changed, 31 insertions, 1 deletions

diff --git a/luxio.c b/luxio.c
index 99f3752..ef32bba 100644
--- a/luxio.c
+++ b/luxio.c
@@ -1949,7 +1949,7 @@ luxio_mq_timedreceive(lua_State *L) /* POSIX.1-2001 */
 
 /* Nope: use a threading library. */
 
-/* Socket-handling ***********************************************************/
+/**# Socket handling *********************************************************/
 
 #define LUXIO_SOCKADDR_METATABLE_NAME "luxio.sockaddr"
 #ifndef UNIX_PATH_MAX
@@ -2125,6 +2125,10 @@ luxio_makesockaddr(lua_State *L)
 	return luaL_error(L, "unknown socket family %d", family);
 }
 
+/**% socket
+ * retval = socket(domain, type, protocol);
+ * retval, errno = socket(domain, type, protocol)
+ */
 static int
 luxio_socket(lua_State *L)
 {
@@ -2138,6 +2142,10 @@ luxio_socket(lua_State *L)
 	return 2;
 }
 
+/**% listen
+ * retval = listen(fd, backlog);
+ * retval, errno = listen(fd, backlog)
+ */
 static int
 luxio_listen(lua_State *L)
 {
@@ -2150,6 +2158,10 @@ luxio_listen(lua_State *L)
 	return 2;
 }
 
+/**% shutdown
+ * retval = shutdown(fd, how);
+ * retval, errno = shutdown(fd, how)
+ */
 static int
 luxio_shutdown(lua_State *L)
 {
@@ -2162,6 +2174,10 @@ luxio_shutdown(lua_State *L)
 	return 2;
 }
 
+/**% connect
+ * retval = connect(fd, sockaddr, sockaddrlen);
+ * retval, errno = connect(fd, sockaddr)
+ */
 static int
 luxio_connect(lua_State *L)
 {
@@ -2175,6 +2191,10 @@ luxio_connect(lua_State *L)
 	return 2;
 }
 
+/**% bind
+ * retval = bind(fd, sockaddr, sockaddrlen);
+ * retval, errno = bind(fd, sockaddr)
+ */
 static int
 luxio_bind(lua_State *L)
 {
@@ -2188,6 +2208,11 @@ luxio_bind(lua_State *L)
 	return 2;
 }
 
+/**% accept
+ * retval = accept(fd, sockaddrinfo, sockaddrlen);
+ * retval, sockaddr = accept(fd)
+ * retval, errno = accept(fd)
+ */
 static int
 luxio_accept(lua_State *L)
 {
@@ -2209,6 +2234,11 @@ luxio_accept(lua_State *L)
 	return 2;
 }
 
+/**% getsockopt
+ * retval = getsockopt(fd, level, optname, optval, optlen);
+ * retval, errno = getsockopt(fd, level, optname)
+ * retval, opt = getsockopet(fd, level, optname)
+ */
 static int
 luxio_getsockopt(lua_State *L)
 {