diff options
| author | David Robillard <d@drobilla.net> | 2022-10-20 21:03:17 -0400 |
|---|---|---|
| committer | David Robillard <d@drobilla.net> | 2022-10-20 21:10:24 -0400 |
| commit | 668ffa3febb116d20add6e9460fb1fb521a22e35 (patch) | |
| tree | 888e51d4b7c853f4afe77743a2d846e6799cef5f /include/zix/thread.h | |
| parent | 1a98f16aabf9e2c28f97b8ec89ae35af5a333252 (diff) | |
| download | zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.gz zix-668ffa3febb116d20add6e9460fb1fb521a22e35.tar.bz2 zix-668ffa3febb116d20add6e9460fb1fb521a22e35.zip | |
Fix doc comments
Diffstat (limited to 'include/zix/thread.h')
| -rw-r--r-- | include/zix/thread.h | 16 |
1 files changed, 7 insertions, 9 deletions
diff --git a/include/zix/thread.h b/include/zix/thread.h index 482315a..173cc39 100644 --- a/include/zix/thread.h +++ b/include/zix/thread.h @@ -1,4 +1,4 @@ -// Copyright 2012-2020 David Robillard <d@drobilla.net> +// Copyright 2012-2022 David Robillard <d@drobilla.net> // SPDX-License-Identifier: ISC #ifndef ZIX_THREAD_H @@ -20,22 +20,21 @@ extern "C" { #endif /** - @addtogroup zix - @{ - @name Thread + @defgroup zix_thread Thread + @ingroup zix @{ */ #ifdef _WIN32 -# define ZIX_THREAD_RESULT 0 -# define ZIX_THREAD_FUNC __stdcall +# define ZIX_THREAD_RESULT 0 ///< Result returned from a thread function +# define ZIX_THREAD_FUNC __stdcall ///< Thread function attribute typedef HANDLE ZixThread; typedef DWORD ZixThreadResult; #else -# define ZIX_THREAD_RESULT NULL -# define ZIX_THREAD_FUNC +# define ZIX_THREAD_RESULT NULL ///< Result returned from a thread function +# define ZIX_THREAD_FUNC ///< Thread function attribute typedef pthread_t ZixThread; typedef void* ZixThreadResult; @@ -118,7 +117,6 @@ zix_thread_join(ZixThread thread) /** @} - @} */ #ifdef __cplusplus |