edg-l/ddnet
1
0
Fork 0
mirror of https://github.com/ddnet/ddnet.git synced 2024-11-10 01:58:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add documentation for shell_execute and kill_process functions

Browse source
This commit is contained in:
Robert Müller 2024-01-25 19:23:48 +01:00
parent 725ebc929e
commit 4d206ffab3
1 changed files with 14 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

31
src/base/system.h
View file

@ -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);
/**