From 8fe33a340b8979a73fa84f201c15519a9b5d0266 Mon Sep 17 00:00:00 2001 From: Tavian Barnes Date: Sun, 14 Nov 2010 21:20:43 -0500 Subject: Document libdimension with Doxygen. --- libdimension/threads.h | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) (limited to 'libdimension/threads.h') diff --git a/libdimension/threads.h b/libdimension/threads.h index 00be0a9..7ae6288 100644 --- a/libdimension/threads.h +++ b/libdimension/threads.h @@ -18,15 +18,28 @@ * . * *************************************************************************/ +/** + * @file + * Background threading interface. + */ + #ifndef DIMENSION_IMPL_THREADS_H #define DIMENSION_IMPL_THREADS_H -#include - +/** + * Thread callback type. + * @param[in,out] ptr An arbitrary pointer. + * @return 0 on success, non-zero on failure. + */ typedef int dmnsn_thread_fn(void *ptr); -/* Creates a thread that cleans up after itself on errors */ -void dmnsn_new_thread(dmnsn_progress *progress, const pthread_attr_t *attr, - dmnsn_thread_fn *thread_fn, void *arg); +/** + * Create a thread that cleans up after itself on errors. + * @param[in,out] progress The progress object to associate with the thread. + * @param[in] thread_fn The thread callback. + * @param[in,out] arg The pointer to pass to the thread callback. + */ +void dmnsn_new_thread(dmnsn_progress *progress, dmnsn_thread_fn *thread_fn, + void *arg); #endif /* DIMENSION_IMPL_THREADS_H */ -- cgit v1.2.3