diff scid/page-static.h @ 33:1d0ddf9e6efd

misc: general documentation
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 16:47:10 +0200
parents 7e10cace67a3
children 71cd8447e3a4
line wrap: on
line diff
--- a/scid/page-static.h	Thu Aug 04 14:59:33 2022 +0200
+++ b/scid/page-static.h	Thu Aug 04 16:47:10 2022 +0200
@@ -2,11 +2,11 @@
  * page-static.h -- page /static
  *
  * Copyright (c) 2020-2022 David Demelier <markand@malikania.fr>
- * 
+ *
  * Permission to use, copy, modify, and/or distribute this software for any
  * purpose with or without fee is hereby granted, provided that the above
  * copyright notice and this permission notice appear in all copies.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
@@ -16,12 +16,25 @@
  * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  */
 
-#ifndef IMGUP_PAGE_STATIC_H
-#define IMGUP_PAGE_STATIC_H
+#ifndef SCID_PAGE_STATIC_H
+#define SCID_PAGE_STATIC_H
+
+/**
+ * \file page-static.h
+ * \brief Page /static
+ *
+ * This module does not log messages.
+ */
 
 struct kreq;
 
+/**
+ * Run the page.
+ *
+ * \pre r != NULL
+ * \param r the request
+ */
 void
-page_static(struct kreq *);
+page_static(struct kreq *r);
 
-#endif /* !IMGUP_PAGE_STATIC_H */
+#endif /* !SCID_PAGE_STATIC_H */