summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@tavianator.com>2014-04-23 14:45:00 -0400
committerTavian Barnes <tavianator@tavianator.com>2014-04-23 14:45:00 -0400
commit11bacbe9ebbd9c91b7e4b25bc2e390413abe1868 (patch)
treeb5b1537b5b7d35c2452ba7cf5a57ecdd2ec58d37
parent14bb178315820660a53b0159c74cdacf81415a48 (diff)
downloaddimension-11bacbe9ebbd9c91b7e4b25bc2e390413abe1868.tar.xz
threads.h: Fix some internal documentation.
-rw-r--r--libdimension/threads.h10
1 files changed, 5 insertions, 5 deletions
diff --git a/libdimension/threads.h b/libdimension/threads.h
index ea9fb2a..3fba3b9 100644
--- a/libdimension/threads.h
+++ b/libdimension/threads.h
@@ -1,5 +1,5 @@
/*************************************************************************
- * Copyright (C) 2010-2011 Tavian Barnes <tavianator@tavianator.com> *
+ * Copyright (C) 2010-2014 Tavian Barnes <tavianator@tavianator.com> *
* *
* This file is part of The Dimension Library. *
* *
@@ -80,7 +80,7 @@ DMNSN_INTERNAL void dmnsn_unlock_mutex_impl(pthread_mutex_t *mutex);
#define dmnsn_lock_mutex(mutex) dmnsn_lock_mutex_impl((mutex)); {
/**
- * Lock a mutex, bailing out on failure.
+ * Unlock a mutex, bailing out on failure.
* Contains a }, so must be used in the same block as dmnsn_lock_mutex().
* @param[in,out] mutex The mutex to unlock.
*/
@@ -106,21 +106,21 @@ DMNSN_INTERNAL void dmnsn_write_lock_impl(pthread_rwlock_t *rwlock);
DMNSN_INTERNAL void dmnsn_unlock_rwlock_impl(pthread_rwlock_t *rwlock);
/**
- * Lock a read-write lock, bailing out on failure.
+ * Read-lock a read-write lock, bailing out on failure.
* Contains a {, so must be used in the same block as dmnsn_unlock_rwlock().
* @param[in,out] rwlock The read-write lock to lock.
*/
#define dmnsn_read_lock(rwlock) dmnsn_read_lock_impl((rwlock)); {
/**
- * Lock a read-write lock, bailing out on failure.
+ * Write-lock a read-write lock, bailing out on failure.
* Contains a {, so must be used in the same block as dmnsn_unlock_rwlock().
* @param[in,out] rwlock The read-write lock to lock.
*/
#define dmnsn_write_lock(rwlock) dmnsn_write_lock_impl((rwlock)); {
/**
- * Lock a read-write lock, bailing out on failure.
+ * Unlock a read-write lock, bailing out on failure.
* Contains a }, so must be used in the same block as dmnsn_read_lock() or
* dmnsn_write_lock().
* @param[in,out] rwlock The read-write lock to lock.