From 4d206ffab353007087d01bdd4d2da133882e0bec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20M=C3=BCller?= Date: Thu, 25 Jan 2024 19:23:48 +0100 Subject: [PATCH] Add documentation for `shell_execute` and `kill_process` functions --- src/base/system.h | 31 ++++++++++++++----------------- 1 file changed, 14 insertions(+), 17 deletions(-) diff --git a/src/base/system.h b/src/base/system.h index 48046daaf..d963d4289 100644 --- a/src/base/system.h +++ b/src/base/system.h @@ -2517,26 +2517,23 @@ typedef pid_t PROCESS; constexpr PROCESS INVALID_PROCESS = 0; #endif -/* - Function: shell_execute - Executes a given file. - Returns: - handle/pid of the new process -*/ +/** + * Executes a given file. + * + * @param file The file to execute. + * + * @return Handle of the new process, or `INVALID_PROCESS` on error. + */ PROCESS shell_execute(const char *file); -/* - Function: kill_process - Sends kill signal to a process. - - Parameters: - process - handle/pid of the process - - Returns: - 0 - Error - 1 - Success -*/ +/** + * Sends kill signal to a process. + * + * @param process Handle of the process to kill. + * + * @return 1 on success, 0 on error. + */ int kill_process(PROCESS process); /**