ogg_afh.c: Kill unused vi_bitrate_nominal
[paraslash.git] / client.c
index 12812c9f79ecd0a4b5b88707c88572f709ea3fdd..9565102709f53446e7ebf5e978fd9bae733f4dc0 100644 (file)
--- a/client.c
+++ b/client.c
@@ -63,8 +63,19 @@ static void client_event_handler(struct task *t)
        register_task(&sot.task);
 }
 
-/*
- * MAIN
+/**
+ * the client program to connect to para_server
+ *
+ * \param argc usual argument count
+ * \param argv usual argument vector
+ *
+ * It registers two tasks: The client task that communicates with para_server
+ * and the standard out task that writes any output produced by the client task
+ * to standard out.
+ *
+ * \return EXIT_SUCCESS or EXIT_FAILURE
+ *
+ * \sa client_open(), stdout.c, stdout.h, para_client(1), para_server(1)
  */
 int main(int argc, char *argv[])
 {