From 668ffa3febb116d20add6e9460fb1fb521a22e35 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 20 Oct 2022 21:03:17 -0400 Subject: Fix doc comments --- include/zix/thread.h | 16 +++++++--------- 1 file changed, 7 insertions(+), 9 deletions(-) (limited to 'include/zix/thread.h') 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 +// Copyright 2012-2022 David Robillard // 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 -- cgit v1.2.1