1
mirror of https://code.videolan.org/videolan/vlc synced 2024-09-28 23:09:59 +02:00

vlc_waitpid: fix the documentation

It is currently unspecified what happens if the process does not exit
cleanly, so clarify that. Since this can actually happen, the
documentation ought to state what the result is to some extent.
This commit is contained in:
Rémi Denis-Courmont 2022-09-03 12:27:30 +03:00 committed by Jean-Baptiste Kempf
parent 9471dc800c
commit bdf0ec7b51

View File

@ -84,7 +84,9 @@ int vlc_spawnp(pid_t *pid, const char *path, const int *fdv,
*
* \param pid process identifier as returned by vlc_spawn() or vlc_spawnp()
*
* \return This function returns the process exit code.
* \return If the process terminates cleanly, this function returns the exit
* code of the process. Otherwise, it returns an implementation-defined value
* that is not a valid exit code.
*/
VLC_API
int vlc_waitpid(pid_t pid);