summaryrefslogtreecommitdiffstats
path: root/cpukit/posix/include/semaphore.h
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-15 16:03:12 -0500
committerGedare Bloom <gedare@rtems.org>2012-12-15 16:03:12 -0500
commitd86308bdf8d231cd02bb72e4669f12c2689f4dac (patch)
treeb06e87f5718b4c3e0334fa8e17a219552ed9b923 /cpukit/posix/include/semaphore.h
parentposix: Doxygen Enhancement Task #8 (diff)
downloadrtems-d86308bdf8d231cd02bb72e4669f12c2689f4dac.tar.bz2
posix: Doxygen Enhancement Task #2
http://www.google-melange.com/gci/task/view/google/gci2012/7988213
Diffstat (limited to 'cpukit/posix/include/semaphore.h')
-rw-r--r--cpukit/posix/include/semaphore.h24
1 files changed, 17 insertions, 7 deletions
diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h
index 17c583240c..59ed9e6703 100644
--- a/cpukit/posix/include/semaphore.h
+++ b/cpukit/posix/include/semaphore.h
@@ -74,15 +74,24 @@ sem_t *sem_open(
...
);
-/*
- * 11.2.4 Close a Named Semaphore, P1003.1b-1993, p.224
+/**
+ * @brief Close a Named Semaphore
+ *
+ * Routine to close a semaphore that has been opened or initialized.
+ *
+ * 11.2.4 Close a Named Semaphore, P1003.1b-1993, p.224
*/
int sem_close(
sem_t *sem
);
-/*
- * 11.2.5 Remove a Named Semaphore, P1003.1b-1993, p.225
+/**
+ * @brief Remove a Named Semaphore
+ *
+ * Unlinks a named semaphore, sem_close must also be called to remove
+ * the semaphore.
+ *
+ * 11.2.5 Remove a Named Semaphore, P1003.1b-1993, p.225
*/
int sem_unlink(
const char *name
@@ -124,10 +133,11 @@ int sem_post(
sem_t *sem
);
-/*
- * 11.2.8 Get the Value of a Semaphore, P1003.1b-1993, p.229
+/**
+ * @brief Get the Value of a Semaphore
+ *
+ * 11.2.8 Get the Value of a Semaphore, P1003.1b-1993, p.229
*/
-
int sem_getvalue(
sem_t *sem,
int *sval