From d9c9b4e15e2ecbf06c5ba74398c2d5cac37270af Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Odin=20Omdal=20H=C3=B8rthe?= Date: Sat, 20 Oct 2007 17:08:12 +0200 Subject: [PATCH] Moved function doc from rwlock.h to rwlock.c --- src/lib/rwlock.c | 29 +++++++++++++++++++++++++++++ src/lib/rwlock.h | 29 ----------------------------- 2 files changed, 29 insertions(+), 29 deletions(-) diff --git a/src/lib/rwlock.c b/src/lib/rwlock.c index 018c69f63..d59b8c2d2 100644 --- a/src/lib/rwlock.c +++ b/src/lib/rwlock.c @@ -27,6 +27,11 @@ CINELERRA_ERROR_DEFINE(RWLOCK_AGAIN, "maximum number of readlocks exceed"); CINELERRA_ERROR_DEFINE(RWLOCK_DEADLOCK, "deadlock detected"); +/** + * Initialize a rwlock + * @param self is a pointer to the rwlock to be initialized + * @return self as given + */ CinelerraRWLock cinelerra_rwlock_init (CinelerraRWLock self) { @@ -37,6 +42,11 @@ cinelerra_rwlock_init (CinelerraRWLock self) return self; } +/** + * destroy a rwlock + * @param self is a pointer to the rwlock to be initialized + * @return self on success or NULL at error + */ CinelerraRWLock cinelerra_rwlock_destroy (CinelerraRWLock self) { @@ -51,6 +61,13 @@ cinelerra_rwlock_destroy (CinelerraRWLock self) +/** + * initialize a rwlockacquirer state + * @param self rwlockacquirer to be initialized, must be an automatic variable + * @param cond associated rwlock + * @param state initial state of the mutex, either CINELERRA_RDLOCKED, CINELERRA_WRLOCKED or CINELERRA_UNLOCKED + * @return self as given or NULL on error + */ CinelerraRWLockacquirer cinelerra_rwlockacquirer_init (CinelerraRWLockacquirer self, CinelerraRWLock rwlock, enum cinelerra_lockstate state) { @@ -94,6 +111,12 @@ cinelerra_rwlockacquirer_init (CinelerraRWLockacquirer self, CinelerraRWLock rwl } +/** + * readlock the rwlock. + * must not already be locked + * @param self rwlockacquirer associated with a rwlock + * @return self as given or NULL on error + */ CinelerraRWLockacquirer cinelerra_rwlockacquirer_rdlock (CinelerraRWLockacquirer self) { @@ -119,6 +142,12 @@ cinelerra_rwlockacquirer_rdlock (CinelerraRWLockacquirer self) } +/** + * writelock the rwlock. + * must not already be locked + * @param self rwlockacquirer associated with a rwlock + * @return self as given or NULL on error + */ CinelerraRWLockacquirer cinelerra_rwlockacquirer_wrlock (CinelerraRWLockacquirer self) { diff --git a/src/lib/rwlock.h b/src/lib/rwlock.h index 9bc07f9f3..c7cc7ed16 100644 --- a/src/lib/rwlock.h +++ b/src/lib/rwlock.h @@ -47,20 +47,10 @@ typedef struct cinelerra_rwlock_struct cinelerra_rwlock; typedef cinelerra_rwlock* CinelerraRWLock; -/** - * Initialize a rwlock - * @param self is a pointer to the rwlock to be initialized - * @return self as given - */ CinelerraRWLock cinelerra_rwlock_init (CinelerraRWLock self); -/** - * destroy a rwlock - * @param self is a pointer to the rwlock to be initialized - * @return self on success or NULL at error - */ CinelerraRWLock cinelerra_rwlock_destroy (CinelerraRWLock self); @@ -90,32 +80,13 @@ cinelerra_rwlockacquirer_ensureunlocked (CinelerraRWLockacquirer self) cinelerra_rwlockacquirer NOBUG_CLEANUP(cinelerra_rwlockacquirer_ensureunlocked) -/** - * initialize a rwlockacquirer state - * @param self rwlockacquirer to be initialized, must be an automatic variable - * @param cond associated rwlock - * @param state initial state of the mutex, either CINELERRA_RDLOCKED, CINELERRA_WRLOCKED or CINELERRA_UNLOCKED - * @return self as given or NULL on error - */ CinelerraRWLockacquirer cinelerra_rwlockacquirer_init (CinelerraRWLockacquirer self, CinelerraRWLock rwlock, enum cinelerra_lockstate state); -/** - * readlock the rwlock. - * must not already be locked - * @param self rwlockacquirer associated with a rwlock - * @return self as given or NULL on error - */ CinelerraRWLockacquirer cinelerra_rwlockacquirer_rdlock (CinelerraRWLockacquirer self); -/** - * writelock the rwlock. - * must not already be locked - * @param self rwlockacquirer associated with a rwlock - * @return self as given or NULL on error - */ CinelerraRWLockacquirer cinelerra_rwlockacquirer_wrlock (CinelerraRWLockacquirer self);