diff options
| author | Alex Ivanov <alexivanov97@gmail.com> | 2012-12-15 07:25:05 -0500 |
|---|---|---|
| committer | Gedare Bloom <gedare@rtems.org> | 2012-12-15 07:25:05 -0500 |
| commit | e43f4758af5414a28f82c8178f2b53d23031376a (patch) | |
| tree | 36d25b816ad087a9aa22748824ca4a3cc38e33d9 /cpukit/posix/include/rtems/posix/mutex.h | |
| parent | libcsupport: Doxygen Enhancement Task #8 (diff) | |
| download | rtems-e43f4758af5414a28f82c8178f2b53d23031376a.tar.bz2 | |
posix: Doxygen Enhancement Task #1
http://www.google-melange.com/gci/task/view/google/gci2012/7987220
Diffstat (limited to '')
| -rw-r--r-- | cpukit/posix/include/rtems/posix/mutex.h | 16 |
1 files changed, 14 insertions, 2 deletions
diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h index dc133d5421..0d73022f95 100644 --- a/cpukit/posix/include/rtems/posix/mutex.h +++ b/cpukit/posix/include/rtems/posix/mutex.h @@ -21,6 +21,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_MUTEX POSIX Mutex Support + * + * @ingroup POSIX + * + * @brief Private Support Information for POSIX Mutex + */ + #include <rtems/score/coremutex.h> #include <pthread.h> @@ -129,13 +137,17 @@ int _POSIX_Mutex_Lock_support( Watchdog_Interval timeout ); -/* - * _POSIX_Mutex_Translate_core_mutex_return_code +/** + * @brief POSIX Mutex Translate Core Mutex Return Code * * DESCRIPTION: * * A support routine which converts core mutex status codes into the * appropriate POSIX status values. + * + * @param[in] the_mutex_status is the mutex status code to translate + * + * @return the translated POSIX status code */ int _POSIX_Mutex_Translate_core_mutex_return_code( |