Changeset 25569 in vbox

Timestamp:

Dec 22, 2009 2:35:11 PM (15 years ago)

Author:

vboxsync

Message:

iprt/lockvalidator.h: docs.

File:

• trunk/include/iprt/lockvalidator.h (modified) (1 diff)

trunk/include/iprt/lockvalidator.h

@@ -492 +492 @@
 RTDECL(RTTHREAD) RTLockValidatorUnsetOwner(PRTLOCKVALIDATORREC pRec);
 
+/**
+ * Adds an owner to a shared locking record.
+ *
+ * Takes recursion into account.  This function is typically called after
+ * acquiring the lock.
+ *
+ * @param   pRead               The validator record.
+ * @param   hThread             The thread to add.
+ * @param   pSrcPos             The source position of the lock operation.
+ */
 RTDECL(void) RTLockValidatorAddReadOwner(PRTLOCKVALIDATORSHARED pRead, RTTHREAD hThread, PCRTLOCKVALIDATORSRCPOS pSrcPos);
+
+/**
+ * Removes an owner from a shared locking record.
+ *
+ * Takes recursion into account.  This function is typically called before
+ * releaseing the lock.
+ *
+ * @param   pRead               The validator record.
+ * @param   hThread             The thread to to remove.
+ */
 RTDECL(void) RTLockValidatorRemoveReadOwner(PRTLOCKVALIDATORSHARED pRead, RTTHREAD hThread);