lib9p: srv.h: Fuss with doc comments

1 files changed, 17 insertions, 1 deletions

diff --git a/lib9p/include/lib9p/srv.h b/lib9p/include/lib9p/srv.h
index 83aabc0..1057e42 100644
--- a/lib9p/include/lib9p/srv.h
+++ b/lib9p/include/lib9p/srv.h
@@ -103,16 +103,32 @@ struct lib9p_srv {
 };
 
 /**
+ * In an infinite loop, accept a connection and read messages from it until
+ * close; dispatching requests to a pool of lib9p_srv_write_cr() coroutines
+ * with the same `srv`.
+ *
  * Will just close the connection if a T-message has a size[4] <7.
  *
+ * @param srv: The server configuration and state; has an associated pool of
+ *             lib9p_srv_write_cr() coroutines.
+ * @param listener: The listener object to accept connections from.
+ *
  * @errno LINUX_EMSGSIZE T-message has size[4] bigger than max_msg_size
  * @errno LINUX_EDOM Tversion specified an impossibly small max_msg_size
  * @errno LINUX_EOPNOTSUPP T-message has an R-message type, or an unrecognized T-message type
  * @errno LINUX_EBADMSG T-message has wrong size[4] for its content, or has invalid UTF-8
  * @errno LINUX_ERANGE R-message does not fit into max_msg_size
  */
-
 [[noreturn]] void lib9p_srv_read_cr(struct lib9p_srv *srv, lo_interface net_stream_listener listener);
+
+/**
+ * Service requests to the `struct lib9p_srv *srv` argument that have been
+ * read by lib9p_srv_read_cr().
+ *
+ * @param struct lib9p_srv *srv: The server configuration and state; has an
+ *                               associated pool of lib9p_srv_read_cr()
+ *                               coroutines.
+ */
 COROUTINE lib9p_srv_write_cr(void *_srv);
 
 #endif /* _LIB9P_SRV_H_ */