diff scid/http.h @ 33:1d0ddf9e6efd

misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents 081e1c258e64
children 71cd8447e3a4
line wrap: on
line diff
--- a/scid/http.h	Thu Aug 04 14:59:33 2022 +0200
+++ b/scid/http.h	Thu Aug 04 16:47:10 2022 +0200
@@ -19,9 +19,24 @@
 #ifndef SCI_HTTP_H
 #define SCI_HTTP_H
 
+/**
+ * \file http.h
+ * \brief HTTP parser.
+ *
+ * This module uses kcgi to run as simple CGI or FastCGI.
+ *
+ * This module logs message with tag `http`.
+ */
+
+/**
+ * Loop forever for new requests as a FastCGI program.
+ */
 void
 http_fcgi_run(void);
 
+/**
+ * Run one time as simple CGI program.
+ */
 void
 http_cgi_run(void);