summaryrefslogtreecommitdiff
path: root/sal/inc/osl/semaphor.hxx
diff options
context:
space:
mode:
authorOliver Braun <obr@openoffice.org>2001-11-12 14:51:50 +0000
committerOliver Braun <obr@openoffice.org>2001-11-12 14:51:50 +0000
commit6d62202d1cfd2cd6bf30748bbca6754e909223d8 (patch)
tree2f932c84cfc7f06eb588aef9b5285147dd36cfe8 /sal/inc/osl/semaphor.hxx
parenteca0b7aab80811bd4aa03aaf8b5f1ba8bd961002 (diff)
#88337# docu review
Diffstat (limited to 'sal/inc/osl/semaphor.hxx')
-rw-r--r--sal/inc/osl/semaphor.hxx33
1 files changed, 19 insertions, 14 deletions
diff --git a/sal/inc/osl/semaphor.hxx b/sal/inc/osl/semaphor.hxx
index 7b2e00a0d622..8e0b14e47957 100644
--- a/sal/inc/osl/semaphor.hxx
+++ b/sal/inc/osl/semaphor.hxx
@@ -2,9 +2,9 @@
*
* $RCSfile: semaphor.hxx,v $
*
- * $Revision: 1.4 $
+ * $Revision: 1.5 $
*
- * last change: $Author: jl $ $Date: 2001-03-14 08:30:26 $
+ * last change: $Author: obr $ $Date: 2001-11-12 15:51:50 $
*
* The Contents of this file are made available subject to the terms of
* either of the following licenses
@@ -75,11 +75,11 @@ namespace osl
public:
- /** Creates a semaphore.<BR>
+ /** Creates a semaphore.
@param InitialCount denotes the starting value the semaphore. If you set it to
zero, the first acquire() blocks. Otherwise InitialCount acquire()s are
immedeatly successfull.
- @return 0 if the semaphore could not be created, otherwise a handle to the sem.
+ @seealso ::osl_createSemaphore()
*/
Semaphore(sal_uInt32 initialCount)
@@ -88,34 +88,39 @@ namespace osl
}
/** Release the OS-structures and free semaphore data-structure
- @return fbbb
+ @seealso ::osl_destroySemaphore()
*/
~Semaphore()
{
osl_destroySemaphore(semaphore);
}
- /** acquire() decreases the count. It will block if it tries to
- decrease below zero.
- @return False if the system-call failed.
+ /** Decreases the count of the semaphore object.
+
+ It will block if it tries to decrease below zero.
+ @return sal_False if the system-call failed
+ @seealso ::osl_acquireSemaphore()
*/
sal_Bool acquire()
{
return osl_acquireSemaphore(semaphore);
}
- /** tryToAcquire() tries to decreases the count. It will
- return with False if it would decrease the count below zero.
- (When acquire() would block.) If it could successfully
- decrease the count, it will return True.
+ /** Tries to decreases the count of the semaphore.
+
+ @return sal_False if it would decrease the count below zero
+ (acquire() would block). If it could successfully
+ decrease the count, it will return sal_True.
+ @seealso ::osl_tryToAcquireSemaphore()
*/
sal_Bool tryToAcquire()
{
return osl_tryToAcquireSemaphore(semaphore);
}
- /** release() increases the count.
- @return False if the system-call failed.
+ /** Increases the count.
+ @return sal_False if the system-call failed.
+ @seealso ::osl_releaseSemaphore()
*/
sal_Bool release()
{