diff options
| author | David Robillard <d@drobilla.net> | 2023-05-10 16:59:02 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2023-05-11 00:44:30 -0400 |
| commit | 71b215560249747a2f1c3d16f9d372e5b668c45e (patch) | |
| tree | bfb0fc8eecee6c28c00f159f6ec871b5859bedb5 /include/zix/thread.h | |
| parent | 67526c25f4a751be27d2f9eed38d07fe52342aa5 (diff) | |
| download | zix-71b215560249747a2f1c3d16f9d372e5b668c45e.tar.gz zix-71b215560249747a2f1c3d16f9d372e5b668c45e.tar.bz2 zix-71b215560249747a2f1c3d16f9d372e5b668c45e.zip | |
Improve reference documentation
Diffstat (limited to 'include/zix/thread.h')
| -rw-r--r-- | include/zix/thread.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/include/zix/thread.h b/include/zix/thread.h index d3b5021..2493ed3 100644 --- a/include/zix/thread.h +++ b/include/zix/thread.h @@ -59,6 +59,8 @@ typedef ZixThreadResult(ZIX_THREAD_FUNC* ZixThreadFunc)(void*); The thread will immediately be launched, calling `function` with `arg` as the only parameter. + + @return #ZIX_STATUS_SUCCESS on success, or #ZIX_STATUS_ERROR. */ ZIX_API ZixStatus @@ -67,7 +69,11 @@ zix_thread_create(ZixThread* thread, ZixThreadFunc function, void* arg); -/// Join `thread` (block until `thread` exits) +/** + Join `thread` (block until `thread` exits). + + @return #ZIX_STATUS_SUCCESS on success, or #ZIX_STATUS_ERROR. +*/ ZIX_API ZixStatus zix_thread_join(ZixThread thread); |