From 62fc51338d7259c2ea39f38bd8c7d9552e9b2002 Mon Sep 17 00:00:00 2001
From: Kimplul <kimi.h.kuparinen@gmail.com>
Date: Sun, 12 Jun 2022 16:18:47 +0300
Subject: doxygen shows no warnings

+ Does not mean documentation is done, but it's a nice little
  achievement nonetheless.
---
 common/uapi/conf.c | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

(limited to 'common/uapi/conf.c')

diff --git a/common/uapi/conf.c b/common/uapi/conf.c
index 47a7a0f..470b81e 100644
--- a/common/uapi/conf.c
+++ b/common/uapi/conf.c
@@ -15,11 +15,28 @@
 size_t __thread_stack_size = SZ_2M;
 size_t __call_stack_size = SZ_2M;
 
+/**
+ * Configuration parameter read syscall handler.
+ *
+ * \todo Implement parameters.
+ *
+ * @param param Parameter to read.
+ * @return \ref OK and parameter value.
+ */
 SYSCALL_DEFINE1(conf_get)(sys_arg_t param)
 {
 	return (struct sys_ret){ OK, 0 };
 }
 
+/**
+ * Configuration parameter write syscall handler.
+ *
+ * \todo Implement parameters.
+ *
+ * @param param Parameter to write.
+ * @param val Value to set \c param to.
+ * @return \ref OK and \c 0.
+ */
 SYSCALL_DEFINE2(conf_set)(sys_arg_t param, sys_arg_t val)
 {
 	UNUSED(param);
@@ -29,6 +46,13 @@ SYSCALL_DEFINE2(conf_set)(sys_arg_t param, sys_arg_t val)
 	return (struct sys_ret){ OK, 0 };
 }
 
+/**
+ * Poweroff syscall handler.
+ *
+ * @param type Type of poweroff.
+ * @return \ref ERR_INVAL and \c 0 if incorrect poweroff \c type give, otherwise
+ * does not return.
+ */
 SYSCALL_DEFINE1(poweroff)(sys_arg_t type)
 {
 	switch (type) {
-- 
cgit v1.3