diff options
Diffstat (limited to 'cpukit/posix')
216 files changed, 1761 insertions, 520 deletions
diff --git a/cpukit/posix/include/aio.h b/cpukit/posix/include/aio.h index de0bdd5603..f4f824ab69 100644 --- a/cpukit/posix/include/aio.h +++ b/cpukit/posix/include/aio.h @@ -23,6 +23,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_AIO POSIX Asynchronous I/O Support + * + * @ingroup POSIX + * + * @brief POSIX Asynchronous Input and Output + */ + #if defined(_POSIX_ASYNCHRONOUS_IO) /* @@ -126,10 +134,18 @@ ssize_t aio_return( const struct aiocb *aiocbp ); -/* +/** + * @brief Cancel Asynchronous I/O Operation + * * 6.7.7 Cancel Asynchronous I/O Operation, P1003.1b-1993, p. 163 + * + * @param[in] filedes is the file descriptor + * @param[in] aiocbp is the asynchronous I/O control block + * + * @return This method returns AIO_CANCELED if the requested operation(s) + * were canceled. Otherwise, AIO_NOTCANCELED is returned indicating + * that at least one of the requested operation(s) cannot be canceled */ - int aio_cancel( int filedes, struct aiocb *aiocbp diff --git a/cpukit/posix/include/mqueue.h b/cpukit/posix/include/mqueue.h index 56a97a0c7a..a35d94ccc4 100644 --- a/cpukit/posix/include/mqueue.h +++ b/cpukit/posix/include/mqueue.h @@ -2,6 +2,18 @@ * @file mqueue.h * * This file contains the definitions related to POSIX Message Queues. + * + * The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ /* @@ -115,6 +127,13 @@ int mq_send( #include <time.h> +/** + * @brief Send a Message to a Message Queue + * + * 15.2.4 Send a Message to a Message Queue, P1003.1b-1993, p. 277 + * + * @note P1003.4b/D8, p. 45 adds mq_timedsend(). + */ int mq_timedsend( mqd_t mqdes, const char *msg_ptr, @@ -125,12 +144,13 @@ int mq_timedsend( #endif /* _POSIX_TIMEOUTS */ -/* +/** + * @brief Receive a Message From a Message Queue + * * 15.2.5 Receive a Message From a Message Queue, P1003.1b-1993, p. 279 * - * NOTE: P1003.4b/D8, p. 45 adds mq_timedreceive(). + * @note P1003.4b/D8, p. 45 adds mq_timedreceive(). */ - ssize_t mq_receive( mqd_t mqdes, char *msg_ptr, @@ -152,11 +172,12 @@ ssize_t mq_timedreceive( #if defined(_POSIX_REALTIME_SIGNALS) -/* - * 15.2.6 Notify Process that a Message is Available on a Queue, - * P1003.1b-1993, p. 280 +/** + * @brief Notify Process that a Message is Available on a Queue + * + * 15.2.6 Notify Process that a Message is Available on a Queue, + * P1003.1b-1993, p. 280 */ - int mq_notify( mqd_t mqdes, const struct sigevent *notification @@ -164,10 +185,11 @@ int mq_notify( #endif /* _POSIX_REALTIME_SIGNALS */ -/* - * 15.2.7 Set Message Queue Attributes, P1003.1b-1993, p. 281 +/** + * @brief Set Message Queue Attributes + * + * 15.2.7 Set Message Queue Attributes, P1003.1b-1993, p. 281 */ - int mq_setattr( mqd_t mqdes, const struct mq_attr *mqstat, diff --git a/cpukit/posix/include/rtems/posix/cond.h b/cpukit/posix/include/rtems/posix/cond.h index b089abe4a9..93b5b4cf2a 100644 --- a/cpukit/posix/include/rtems/posix/cond.h +++ b/cpukit/posix/include/rtems/posix/cond.h @@ -148,15 +148,14 @@ int _POSIX_Condition_variables_Signal_support( bool is_broadcast ); -/* - * _POSIX_Condition_variables_Wait_support +/** + * @brief POSIX Condition Variables Wait Support * - * DESCRIPTION: + * DESCRIPTION: * - * A support routine which implements guts of the blocking, non-blocking, and - * timed wait version of condition variable wait routines. + * A support routine which implements guts of the blocking, non-blocking, and + * timed wait version of condition variable wait routines. */ - int _POSIX_Condition_variables_Wait_support( pthread_cond_t *cond, pthread_mutex_t *mutex, diff --git a/cpukit/posix/include/rtems/posix/key.h b/cpukit/posix/include/rtems/posix/key.h index ce4f093b13..edcaa42685 100644 --- a/cpukit/posix/include/rtems/posix/key.h +++ b/cpukit/posix/include/rtems/posix/key.h @@ -58,7 +58,7 @@ POSIX_EXTERN Objects_Information _POSIX_Keys_Information; void _POSIX_Key_Manager_initialization(void); /** - * @brief _POSIX_Keys_Run_destructors + * @brief Thread-Specific Data Key Create * * This function executes all the destructors associated with the thread's * keys. This function will execute until all values have been set to NULL. diff --git a/cpukit/posix/include/rtems/posix/mqueue.h b/cpukit/posix/include/rtems/posix/mqueue.h index ea94669e71..582d5b73b2 100644 --- a/cpukit/posix/include/rtems/posix/mqueue.h +++ b/cpukit/posix/include/rtems/posix/mqueue.h @@ -3,6 +3,18 @@ * * This include file contains all the private support information for * POSIX Message Queues. + * + * The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ /* @@ -23,10 +35,20 @@ #include <rtems/score/object.h> #include <rtems/posix/posixapi.h> +/** + * @defgroup POSIX_MQUEUE_P Message Queues Private Support Information + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif +/** + * @ingroup POSIX_MQUEUE + */ + /* * Data Structure used to manage a POSIX message queue */ @@ -57,11 +79,24 @@ POSIX_EXTERN Objects_Information _POSIX_Message_queue_Information; POSIX_EXTERN Objects_Information _POSIX_Message_queue_Information_fds; /* - * _POSIX_Message_queue_Manager_initialization + * @brief Initializes message_queue Manager Related Data Structures * * DESCRIPTION: * * This routine performs the initialization necessary for this manager. + * + * NOTE: The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. + * */ void _POSIX_Message_queue_Manager_initialization(void); @@ -84,25 +119,36 @@ int _POSIX_Message_queue_Create_support( POSIX_Message_queue_Control **message_queue ); -/* - * _POSIX_Message_queue_Delete +/** + * @brief POSIX Delete Message Queue * * DESCRIPTION: * * This routine supports the mq_unlink and mq_close routines by * doing most of the work involved with removing a message queue. */ - void _POSIX_Message_queue_Delete( POSIX_Message_queue_Control *the_mq ); /* - * _POSIX_Message_queue_Receive_support + * @brief POSIX Message Queue Receive Support * * DESCRIPTION: * * This routine supports the various flavors of receiving a message. + * + * NOTE: The structure of the routines is identical to that of POSIX + * Message_queues to leave the option of having unnamed message + * queues at a future date. They are currently not part of the + * POSIX standard but unnamed message_queues are. This is also + * the reason for the apparently unnecessary tracking of + * the process_shared attribute. [In addition to the fact that + * it would be trivial to add pshared to the mq_attr structure + * and have process private message queues.] + * + * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open + * time. */ ssize_t _POSIX_Message_queue_Receive_support( @@ -228,6 +274,6 @@ int _POSIX_Message_queue_Translate_core_message_queue_return_code( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/posix/include/rtems/posix/mutex.h b/cpukit/posix/include/rtems/posix/mutex.h index dc133d5421..727745ae67 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> @@ -48,7 +56,7 @@ POSIX_EXTERN Objects_Information _POSIX_Mutex_Information; POSIX_EXTERN pthread_mutexattr_t _POSIX_Mutex_Default_attributes; /* - * _POSIX_Mutex_Manager_initialization + * @brief POSIX Mutex Manager Initialization * * DESCRIPTION: * @@ -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( diff --git a/cpukit/posix/include/rtems/posix/priority.h b/cpukit/posix/include/rtems/posix/priority.h index 62ec9fbe2d..a6a3c289da 100644 --- a/cpukit/posix/include/rtems/posix/priority.h +++ b/cpukit/posix/include/rtems/posix/priority.h @@ -17,6 +17,14 @@ #ifndef _RTEMS_POSIX_PRIORITY_H #define _RTEMS_POSIX_PRIORITY_H +/** + * @defgroup POSIX_PRIORITY POSIX Priority Support + * + * @ingroup POSIX + * + * @brief Interface to the POSIX Priority Implementation + */ + #include <rtems/score/priority.h> /** @@ -44,6 +52,8 @@ #define POSIX_SCHEDULER_MINIMUM_PRIORITY (1) /** + * @brief POSIX Is Priority Valid + * * 1003.1b-1993,2.2.2.80 definition of priority, p. 19 * * "Numerically higher values represent higher priorities." diff --git a/cpukit/posix/include/rtems/posix/psignalimpl.h b/cpukit/posix/include/rtems/posix/psignalimpl.h index 6c46f3c49c..c416a7aa1b 100644 --- a/cpukit/posix/include/rtems/posix/psignalimpl.h +++ b/cpukit/posix/include/rtems/posix/psignalimpl.h @@ -16,6 +16,14 @@ #ifndef _RTEMS_POSIX_PSIGNALIMPL_H #define _RTEMS_POSIX_PSIGNALIMPL_H +/** + * @defgroup POSIX_SIGNALS POSIX Signals Support + * + * @ingroup POSIX + * + * @brief Internal Information about POSIX Signals + */ + #include <rtems/posix/psignal.h> #include <rtems/posix/pthread.h> #include <rtems/posix/sigset.h> @@ -63,6 +71,9 @@ extern API_extensions_Post_switch_control _POSIX_signals_Post_switch; * Internal routines */ +/** + * @brief POSIX Signals Manager Initialization + */ void _POSIX_signals_Manager_Initialization(void); static inline void _POSIX_signals_Add_post_switch_extension(void) @@ -70,18 +81,29 @@ static inline void _POSIX_signals_Add_post_switch_extension(void) _API_extensions_Add_post_switch( &_POSIX_signals_Post_switch ); } +/** + * @brief POSIX Signals Thread Unlock + * + * XXX this routine could probably be cleaned up + */ bool _POSIX_signals_Unblock_thread( Thread_Control *the_thread, int signo, siginfo_t *info ); +/** + * @brief POSIX Signals Check Signal + */ bool _POSIX_signals_Check_signal( POSIX_API_Control *api, int signo, bool is_global ); +/** + * @brief POSIX Signals Clear Signals + */ bool _POSIX_signals_Clear_signals( POSIX_API_Control *api, int signo, @@ -96,6 +118,9 @@ int killinfo( const union sigval *value ); +/** + * @brief POSIX Signals Set Process Signals + */ void _POSIX_signals_Set_process_signals( sigset_t mask ); diff --git a/cpukit/posix/include/rtems/posix/pthread.h b/cpukit/posix/include/rtems/posix/pthread.h index 52ad486337..5932d45a39 100644 --- a/cpukit/posix/include/rtems/posix/pthread.h +++ b/cpukit/posix/include/rtems/posix/pthread.h @@ -21,9 +21,24 @@ #include <rtems/posix/config.h> #include <rtems/posix/threadsup.h> +/** + * @defgroup POSIX_PTHREADS Private Threads + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif + +/** + * @defgroup POSIX_PTHREAD POSIX Threads Support + * + * @ingroup POSIX + * + * @brief Private Support Information for POSIX Threads + */ + /** * The following sets the minimum stack size for POSIX threads. */ @@ -164,10 +179,10 @@ int _POSIX_Thread_Translate_sched_param( ); /** - * @brief _POSIX_Threads_Initialize_user_threads_body + * @brief POSIX Threads Initialize User Threads Body * - * This routine creates and starts all configured user - * initialization threads. + * This routine creates and starts all configured user + * initialization threads. */ extern void _POSIX_Threads_Initialize_user_threads_body(void); @@ -176,6 +191,6 @@ extern void _POSIX_Threads_Initialize_user_threads_body(void); #ifdef __cplusplus } #endif - +/**@}*/ #endif /* end of include file */ diff --git a/cpukit/posix/include/rtems/posix/ptimer.h b/cpukit/posix/include/rtems/posix/ptimer.h index a7c083711a..1b791cc915 100644 --- a/cpukit/posix/include/rtems/posix/ptimer.h +++ b/cpukit/posix/include/rtems/posix/ptimer.h @@ -88,13 +88,15 @@ int timer_gettime( struct itimerspec *value ); -/* +/** + * @brief Get Overrun Count for a POSIX Per-Process Timer + * + * The expiration of a timer must increase by one a counter. + * After the signal handler associated to the timer finishes + * its execution, _POSIX_Timer_TSR will have to set this counter to 0. + * * 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267 - * - * timer_getoverrun - * */ - int timer_getoverrun( timer_t timerid ); diff --git a/cpukit/posix/include/rtems/posix/rwlock.h b/cpukit/posix/include/rtems/posix/rwlock.h index c4f2d7e146..411384c2c6 100644 --- a/cpukit/posix/include/rtems/posix/rwlock.h +++ b/cpukit/posix/include/rtems/posix/rwlock.h @@ -27,6 +27,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_RWLOCK POSIX RWLock Manager + * + * @ingroup POSIX + * + * @brief Constants and Structures Associated with the POSIX RWLock Manager + */ + #include <rtems/score/object.h> #include <rtems/score/corerwlock.h> @@ -60,7 +68,7 @@ POSIX_EXTERN Objects_Information _POSIX_RWLock_Information; void _POSIX_RWLock_Manager_initialization(void); /** - * @brief _POSIX_RWLock_Translate_core_RWLock_return_code ( + * @brief POSIX RWLock Translate Core RWLock Return Code * * This routine translates SuperCore RWLock status codes into the * corresponding POSIX ones. diff --git a/cpukit/posix/include/rtems/posix/semaphore.h b/cpukit/posix/include/rtems/posix/semaphore.h index 08df44be4f..08ace7684f 100644 --- a/cpukit/posix/include/rtems/posix/semaphore.h +++ b/cpukit/posix/include/rtems/posix/semaphore.h @@ -17,10 +17,20 @@ #ifndef _RTEMS_POSIX_SEMAPHORE_H #define _RTEMS_POSIX_SEMAPHORE_H +/** + * @defgroup POSIX_SEMAPHORES Semaphore + * + * @ingroup POSIX + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif +/** + * @ingroup POSIX_SEMAPHORE + */ + #include <semaphore.h> #include <rtems/score/coresem.h> #include <rtems/posix/posixapi.h> @@ -134,20 +144,19 @@ int _POSIX_Semaphore_Create_support( POSIX_Semaphore_Control **the_sem ); -/* - * _POSIX_Semaphore_Delete +/** + * @brief POSIX Delete Semaphore * * DESCRIPTION: * * This routine supports the sem_close and sem_unlink routines. */ - void _POSIX_Semaphore_Delete( POSIX_Semaphore_Control *the_semaphore ); /* - * _POSIX_Semaphore_Wait_support + * @brief POSIX Semaphore Wait Support * * DESCRIPTION: * diff --git a/cpukit/posix/include/rtems/posix/spinlock.h b/cpukit/posix/include/rtems/posix/spinlock.h index 892040e8b8..44061bd42c 100644 --- a/cpukit/posix/include/rtems/posix/spinlock.h +++ b/cpukit/posix/include/rtems/posix/spinlock.h @@ -27,6 +27,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_SPINLOCK POSIX Spinlock Support + * + * @ingroup POSIX + * + * @brief Constants and Structures Associated with the POSIX Spinlock Manager + */ + #include <rtems/score/object.h> #include <rtems/score/corespinlock.h> @@ -60,7 +68,7 @@ POSIX_EXTERN Objects_Information _POSIX_Spinlock_Information; void _POSIX_Spinlock_Manager_initialization(void); /** - * @brief _POSIX_Spinlock_Translate_core_spinlock_return_code ( + * @brief POSIX Spinlock Translate Core Spinlock Return Code * * This routine translates SuperCore Spinlock status codes into the * corresponding POSIX ones. diff --git a/cpukit/posix/include/semaphore.h b/cpukit/posix/include/semaphore.h index 91722006ce..37e3fd54b4 100644 --- a/cpukit/posix/include/semaphore.h +++ b/cpukit/posix/include/semaphore.h @@ -21,6 +21,14 @@ extern "C" { #endif +/** + * @defgroup POSIX_SEMAPHORE POSIX Semaphores Support + * + * @ingroup POSIX + * + * @brief Private Support Information for POSIX Semaphores + */ + #include <unistd.h> #if defined(_POSIX_SEMAPHORES) @@ -46,7 +54,9 @@ int sem_init( unsigned int value ); -/* +/** + * @brief Destroy an Unnamed Semaphore + * * 11.2.2 Destroy an Unnamed Semaphore, P1003.1b-1993, p.220 */ int sem_destroy( @@ -64,52 +74,73 @@ 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 ); -/* +/** + * @brief Lock a Semaphore + * * 11.2.6 Lock a Semaphore, P1003.1b-1993, p.226 * - * NOTE: P1003.4b/D8 adds sem_timedwait(), p. 27 + * @note P1003.4b/D8 adds sem_timedwait(), p. 27 */ int sem_wait( sem_t *sem ); +/** + * @brief Lock a Semaphore + * + * @see sem_wait() + */ int sem_trywait( sem_t *sem ); #if defined(_POSIX_TIMEOUTS) +/** + * @brief Lock a Semaphore + */ int sem_timedwait( sem_t *sem, const struct timespec *timeout ); #endif -/* +/** + * @brief Unlock a Semaphore + * * 11.2.7 Unlock a Semaphore, P1003.1b-1993, p.227 */ - 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 diff --git a/cpukit/posix/src/_execve.c b/cpukit/posix/src/_execve.c index 7e6cf23a8a..b606fd63df 100644 --- a/cpukit/posix/src/_execve.c +++ b/cpukit/posix/src/_execve.c @@ -1,6 +1,11 @@ -/* - * execve() - POSIX 1003.1b 3.1.2 +/** + * @file * + * @brief execve() + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/adjtime.c b/cpukit/posix/src/adjtime.c index db88c923e1..23f7d3a9ed 100644 --- a/cpukit/posix/src/adjtime.c +++ b/cpukit/posix/src/adjtime.c @@ -1,9 +1,8 @@ -/* - * adjime() function +/** + * @file * - * This method was initially added as part of porting NTP to RTEMS. - * It is a BSD compatability function and now is available on - * GNU/Linux. + * @brief Correct the Time to Synchronize the System Clock + * @ingroup POSIX */ /* @@ -31,12 +30,15 @@ #include <rtems/score/thread.h> #include <rtems/score/timespec.h> -/* +/** + * This method was initially added as part of porting NTP to RTEMS. + * It is a BSD compatability function and now is available on + * GNU/Linux. + * * At one point there was a static variable named adjustment * used by this implementation. I don't see any reason for it * to be here based upon the GNU/Linux documentation. */ - int adjtime( const struct timeval *delta, struct timeval *olddelta diff --git a/cpukit/posix/src/aio_cancel.c b/cpukit/posix/src/aio_cancel.c index be771e7c33..561e2f8776 100644 --- a/cpukit/posix/src/aio_cancel.c +++ b/cpukit/posix/src/aio_cancel.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Cancel Asynchronous I/O Operation + * @ingroup POSIX_AIO + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * @@ -17,23 +24,6 @@ #include <rtems/system.h> #include <rtems/seterr.h> -/* - * aio_cancel - * - * Cancel an asynchronous I/O request - * - * Input parameters: - * fildes - file descriptor - * aiocbp - asynchronous I/O control block - * - * Output parameters: - * AIO_CANCELED - if the requested operation(s) - * were canceled - * AIO_NOTCANCELED - if at least one of the requested - * operation(s) cannot be canceled - */ - - int aio_cancel(int fildes, struct aiocb *aiocbp) { rtems_aio_request_chain *r_chain; diff --git a/cpukit/posix/src/aio_error.c b/cpukit/posix/src/aio_error.c index 1765f21622..e29c8361b1 100644 --- a/cpukit/posix/src/aio_error.c +++ b/cpukit/posix/src/aio_error.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Returns the error status for the Asynchronous I/O request + * @ingroup POSIX + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * diff --git a/cpukit/posix/src/aio_fsync.c b/cpukit/posix/src/aio_fsync.c index 7021082930..0330076696 100644 --- a/cpukit/posix/src/aio_fsync.c +++ b/cpukit/posix/src/aio_fsync.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Syncing of all Outstanding Asynchronous I/O Operations + * @ingroup POSIX + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * diff --git a/cpukit/posix/src/aio_misc.c b/cpukit/posix/src/aio_misc.c index 80e95636ad..12bec2eb7d 100644 --- a/cpukit/posix/src/aio_misc.c +++ b/cpukit/posix/src/aio_misc.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Actual request being processed + * @ingroup POSIX + */ + /* * Copyright 2010-2011, Alin Rus <alin.codejunkie@gmail.com> * diff --git a/cpukit/posix/src/aio_read.c b/cpukit/posix/src/aio_read.c index 63bbac9c1b..f339752525 100644 --- a/cpukit/posix/src/aio_read.c +++ b/cpukit/posix/src/aio_read.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Asynchronously reads Data from a File + * @ingroup POSIX + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * diff --git a/cpukit/posix/src/aio_return.c b/cpukit/posix/src/aio_return.c index da10ebffa6..87c3af1f3e 100644 --- a/cpukit/posix/src/aio_return.c +++ b/cpukit/posix/src/aio_return.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Final return status for Asynchronous I/O request pointed to by aiobcp + * @ingroup POSIX + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * diff --git a/cpukit/posix/src/aio_suspend.c b/cpukit/posix/src/aio_suspend.c index c42ee83be5..60c4af1389 100644 --- a/cpukit/posix/src/aio_suspend.c +++ b/cpukit/posix/src/aio_suspend.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Suspends Process until Asynchronous I/O Operation completes + * @ingroup POSIX + */ + /* * 6.7.7 Wait for Asynchronous I/O Request, P1003.1b-1993, p. 164 * diff --git a/cpukit/posix/src/aio_write.c b/cpukit/posix/src/aio_write.c index 7895c8c218..a510946837 100644 --- a/cpukit/posix/src/aio_write.c +++ b/cpukit/posix/src/aio_write.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function queues I/O request described by buffer pointed by aiocb + * @ingroup POSIX + */ + /* * Copyright 2010, Alin Rus <alin.codejunkie@gmail.com> * diff --git a/cpukit/posix/src/alarm.c b/cpukit/posix/src/alarm.c index b3c902cbab..22ffcae5c3 100644 --- a/cpukit/posix/src/alarm.c +++ b/cpukit/posix/src/alarm.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief System Generates Signal for process after realtime seconds elapsed + * @ingroup POSIX + */ + /* * 3.4.1 Schedule Alarm, P1003.1b-1993, p. 79 */ diff --git a/cpukit/posix/src/barrierattrdestroy.c b/cpukit/posix/src/barrierattrdestroy.c index f8c1a99355..c0a6fada2c 100644 --- a/cpukit/posix/src/barrierattrdestroy.c +++ b/cpukit/posix/src/barrierattrdestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function shall Destroy a Barrier Attribues Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/barrierattrinit.c b/cpukit/posix/src/barrierattrinit.c index 2363e4d3db..29d58f4991 100644 --- a/cpukit/posix/src/barrierattrinit.c +++ b/cpukit/posix/src/barrierattrinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initialize the Barrier Attributes Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -16,10 +23,6 @@ #include <rtems/system.h> -/* - * Barrier Attributes Initialization - */ - int pthread_barrierattr_init( pthread_barrierattr_t *attr ) diff --git a/cpukit/posix/src/barrierattrsetpshared.c b/cpukit/posix/src/barrierattrsetpshared.c index df3c8017dd..897a833946 100644 --- a/cpukit/posix/src/barrierattrsetpshared.c +++ b/cpukit/posix/src/barrierattrsetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Set the Process-Shared Attribute of the Barrier Attributes Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -14,10 +21,6 @@ #include <pthread.h> #include <errno.h> -/* - * Barrier Attributes Set Process Shared - */ - int pthread_barrierattr_setpshared( pthread_barrierattr_t *attr, int pshared diff --git a/cpukit/posix/src/cancel.c b/cpukit/posix/src/cancel.c index acf13524b8..42321ce93b 100644 --- a/cpukit/posix/src/cancel.c +++ b/cpukit/posix/src/cancel.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Canceling Execution of a Thread + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/canceleval.c b/cpukit/posix/src/canceleval.c index be7400289c..804efb4726 100644 --- a/cpukit/posix/src/canceleval.c +++ b/cpukit/posix/src/canceleval.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Function Evaluates Thread Cancellation and Enables Dispatch + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/cancelrun.c b/cpukit/posix/src/cancelrun.c index 91749281d8..39a8de763d 100644 --- a/cpukit/posix/src/cancelrun.c +++ b/cpukit/posix/src/cancelrun.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Executes a thread's cancellation handlers + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/cleanuppop.c b/cpukit/posix/src/cleanuppop.c index 06e56509b6..9e198f74c9 100644 --- a/cpukit/posix/src/cleanuppop.c +++ b/cpukit/posix/src/cleanuppop.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Removes Routine from Top of Calling Thread's stack and Invoke it + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/clockgetcpuclockid.c b/cpukit/posix/src/clockgetcpuclockid.c index 8908ab6801..fb04e174aa 100644 --- a/cpukit/posix/src/clockgetcpuclockid.c +++ b/cpukit/posix/src/clockgetcpuclockid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Returns Clock ID of CPU-time Clock of process specified + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/clockgetenableattr.c b/cpukit/posix/src/clockgetenableattr.c index 7d7bf895cb..8420c2be88 100644 --- a/cpukit/posix/src/clockgetenableattr.c +++ b/cpukit/posix/src/clockgetenableattr.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Clock get Enable Attribute Access + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/clockgetres.c b/cpukit/posix/src/clockgetres.c index 623fa2433a..60d516d26e 100644 --- a/cpukit/posix/src/clockgetres.c +++ b/cpukit/posix/src/clockgetres.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Returns the Resolution of any Clock + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/clockgettime.c b/cpukit/posix/src/clockgettime.c index 2c5a9da5fa..46c1d46811 100644 --- a/cpukit/posix/src/clockgettime.c +++ b/cpukit/posix/src/clockgettime.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Retrieves the Specified Clock Time + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/clocksetenableattr.c b/cpukit/posix/src/clocksetenableattr.c index 9719147415..592b82341e 100644 --- a/cpukit/posix/src/clocksetenableattr.c +++ b/cpukit/posix/src/clocksetenableattr.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Clock set Enable Attribute Access + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/condattrdestroy.c b/cpukit/posix/src/condattrdestroy.c index 9f4a3949b6..6f686fe1df 100644 --- a/cpukit/posix/src/condattrdestroy.c +++ b/cpukit/posix/src/condattrdestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Destroy Condition Attribute + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/condattrgetpshared.c b/cpukit/posix/src/condattrgetpshared.c index a35f85e414..298c2618b3 100644 --- a/cpukit/posix/src/condattrgetpshared.c +++ b/cpukit/posix/src/condattrgetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get the Process-Shared Condition Variable Attributes + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -22,11 +29,10 @@ #include <rtems/posix/time.h> #include <rtems/posix/mutex.h> -/* +/** * 11.4.1 Condition Variable Initialization Attributes, * P1003.1c/Draft 10, p. 96 */ - int pthread_condattr_getpshared( const pthread_condattr_t *attr, int *pshared diff --git a/cpukit/posix/src/condattrinit.c b/cpukit/posix/src/condattrinit.c index 83728bcdae..89b806cb7e 100644 --- a/cpukit/posix/src/condattrinit.c +++ b/cpukit/posix/src/condattrinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initialization of Conditional Attributes + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/condattrsetpshared.c b/cpukit/posix/src/condattrsetpshared.c index f010038cbc..4e00c920c5 100644 --- a/cpukit/posix/src/condattrsetpshared.c +++ b/cpukit/posix/src/condattrsetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initialize Condition Variable Attributes + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/condbroadcast.c b/cpukit/posix/src/condbroadcast.c index ab2f8713c3..6506d87d98 100644 --- a/cpukit/posix/src/condbroadcast.c +++ b/cpukit/posix/src/condbroadcast.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Broadcast a Condition + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -22,10 +29,9 @@ #include <rtems/posix/time.h> #include <rtems/posix/mutex.h> -/* +/** * 11.4.3 Broadcasting and Signaling a Condition, P1003.1c/Draft 10, p. 101 */ - int pthread_cond_broadcast( pthread_cond_t *cond ) diff --git a/cpukit/posix/src/conddefaultattributes.c b/cpukit/posix/src/conddefaultattributes.c index 7cca0bcb64..32ec64d69a 100644 --- a/cpukit/posix/src/conddefaultattributes.c +++ b/cpukit/posix/src/conddefaultattributes.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Condition variable Attributes structure + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/conddestroy.c b/cpukit/posix/src/conddestroy.c index 905fb1ecca..0f32b89da3 100644 --- a/cpukit/posix/src/conddestroy.c +++ b/cpukit/posix/src/conddestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Destroy a Condition Variable + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -22,11 +29,10 @@ #include <rtems/posix/time.h> #include <rtems/posix/mutex.h> -/* +/** * 11.4.2 Initializing and Destroying a Condition Variable, * P1003.1c/Draft 10, p. 87 */ - int pthread_cond_destroy( pthread_cond_t *cond ) diff --git a/cpukit/posix/src/condinit.c b/cpukit/posix/src/condinit.c index 73f1f5b6b7..2a8321192e 100644 --- a/cpukit/posix/src/condinit.c +++ b/cpukit/posix/src/condinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initialize a Condition Variable + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -22,11 +29,10 @@ #include <rtems/posix/time.h> #include <rtems/posix/mutex.h> -/* +/** * 11.4.2 Initializing and Destroying a Condition Variable, * P1003.1c/Draft 10, p. 87 */ - int pthread_cond_init( pthread_cond_t *cond, const pthread_condattr_t *attr diff --git a/cpukit/posix/src/condsignal.c b/cpukit/posix/src/condsignal.c index 8b5c2c90c4..debc110143 100644 --- a/cpukit/posix/src/condsignal.c +++ b/cpukit/posix/src/condsignal.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Signal a Condition + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -22,10 +29,9 @@ #include <rtems/posix/time.h> #include <rtems/posix/mutex.h> -/* +/** * 11.4.3 Broadcasting and Signaling a Condition, P1003.1c/Draft 10, p. 101 */ - int pthread_cond_signal( pthread_cond_t *cond ) diff --git a/cpukit/posix/src/condwait.c b/cpukit/posix/src/condwait.c index 2540208e16..3162b4d97b 100644 --- a/cpukit/posix/src/condwait.c +++ b/cpukit/posix/src/condwait.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Waiting on a Condition + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/condwaitsupp.c b/cpukit/posix/src/condwaitsupp.c index 79b5c02164..91bdc32a0c 100644 --- a/cpukit/posix/src/condwaitsupp.c +++ b/cpukit/posix/src/condwaitsupp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Condition Variables Wait Support + * @ingroup POSIX_COND_VARS + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -22,13 +29,6 @@ #include <rtems/posix/time.h> #include <rtems/posix/mutex.h> -/* - * _POSIX_Condition_variables_Wait_support - * - * A support routine which implements guts of the blocking, non-blocking, and - * timed wait version of condition variable wait routines. - */ - int _POSIX_Condition_variables_Wait_support( pthread_cond_t *cond, pthread_mutex_t *mutex, diff --git a/cpukit/posix/src/execl.c b/cpukit/posix/src/execl.c index d329e5f7c9..61b9a74fce 100644 --- a/cpukit/posix/src/execl.c +++ b/cpukit/posix/src/execl.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Process will get Executed and then Terminated by execl + * @ingroup POSIX + */ + /* * execl() - POSIX 1003.1b 3.1.2 * diff --git a/cpukit/posix/src/execle.c b/cpukit/posix/src/execle.c index 8199d68c20..1dbd3826a1 100644 --- a/cpukit/posix/src/execle.c +++ b/cpukit/posix/src/execle.c @@ -1,6 +1,11 @@ -/* - * execle() - POSIX 1003.1b 3.1.2 +/** + * @file * + * @brief Execute a File + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/execlp.c b/cpukit/posix/src/execlp.c index 10d44e0019..7a4c5142a6 100644 --- a/cpukit/posix/src/execlp.c +++ b/cpukit/posix/src/execlp.c @@ -1,6 +1,11 @@ -/* - * execlp() - POSIX 1003.1b 3.1.2 +/** + * @file * + * @brief execlp() + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/execv.c b/cpukit/posix/src/execv.c index 8c56274698..26d62b123d 100644 --- a/cpukit/posix/src/execv.c +++ b/cpukit/posix/src/execv.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Inoperable implementation of execv for POSIX threads + * @ingroup POSIX + */ + /* * execv() - POSIX 1003.1b 3.1.2 * diff --git a/cpukit/posix/src/execve.c b/cpukit/posix/src/execve.c index c6f6ede19b..03320e52a0 100644 --- a/cpukit/posix/src/execve.c +++ b/cpukit/posix/src/execve.c @@ -1,6 +1,11 @@ -/* - * execve() - POSIX 1003.1b 3.1.2 +/** + * @file * + * @brief Execute a Program + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -18,6 +23,9 @@ #include <errno.h> #include <rtems/seterr.h> +/** + * POSIX 1003.1b 3.1.2 + */ int execve( const char *path, char *const argv[], diff --git a/cpukit/posix/src/execvp.c b/cpukit/posix/src/execvp.c index 6b4d0e9a39..7712c8cef6 100644 --- a/cpukit/posix/src/execvp.c +++ b/cpukit/posix/src/execvp.c @@ -1,6 +1,11 @@ -/* - * execvp() - POSIX 1003.1b 3.1.2 +/** + * @file * + * @brief execvp() - POSIX 1003.1b 3.1.2 + * @ingroup POSIX_KEY Key + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/fork.c b/cpukit/posix/src/fork.c index ec24f051d7..4cfccf4a02 100644 --- a/cpukit/posix/src/fork.c +++ b/cpukit/posix/src/fork.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Inoperable implementation of fork() for POSIX threads + * @ingroup POSIX + */ + /* * fork() - POSIX 1003.1b 3.1.1 * diff --git a/cpukit/posix/src/getitimer.c b/cpukit/posix/src/getitimer.c index 316d43ea77..a7ee836b04 100644 --- a/cpukit/posix/src/getitimer.c +++ b/cpukit/posix/src/getitimer.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Gets Value of an Interval Timer + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-20089 * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/keycreate.c b/cpukit/posix/src/keycreate.c index 493b6fb278..3ac462dbcb 100644 --- a/cpukit/posix/src/keycreate.c +++ b/cpukit/posix/src/keycreate.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Thread-Specific Data Key Create + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). @@ -21,10 +28,9 @@ #include <rtems/score/wkspace.h> #include <rtems/posix/key.h> -/* +/** * 17.1.1 Thread-Specific Data Key Create, P1003.1c/Draft 10, p. 163 */ - int pthread_key_create( pthread_key_t *key, void (*destructor)( void * ) diff --git a/cpukit/posix/src/keydelete.c b/cpukit/posix/src/keydelete.c index b0b5daa3be..41d57772bf 100644 --- a/cpukit/posix/src/keydelete.c +++ b/cpukit/posix/src/keydelete.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Deletes Thread-specific Data Key Previously Returned by keycreate.c + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/keyfreememory.c b/cpukit/posix/src/keyfreememory.c index d5ef5ee989..35e8a36918 100644 --- a/cpukit/posix/src/keyfreememory.c +++ b/cpukit/posix/src/keyfreememory.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Function Keys Free Memory + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/keygetspecific.c b/cpukit/posix/src/keygetspecific.c index c7b2cc55fc..3a34359297 100644 --- a/cpukit/posix/src/keygetspecific.c +++ b/cpukit/posix/src/keygetspecific.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Thread-Specific Data Management + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/keyrundestructors.c b/cpukit/posix/src/keyrundestructors.c index 888b24715a..9f48888bb8 100644 --- a/cpukit/posix/src/keyrundestructors.c +++ b/cpukit/posix/src/keyrundestructors.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Thread-Specific Data Key Create + * @ingroup POSIX_KEY Key + */ + /* * Copyright (c) 2010 embedded brains GmbH. * diff --git a/cpukit/posix/src/keysetspecific.c b/cpukit/posix/src/keysetspecific.c index 5b7fb8bc96..e631127fba 100644 --- a/cpukit/posix/src/keysetspecific.c +++ b/cpukit/posix/src/keysetspecific.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Set Specific Key + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/kill.c b/cpukit/posix/src/kill.c index ee59fe4b84..8a476e40ce 100644 --- a/cpukit/posix/src/kill.c +++ b/cpukit/posix/src/kill.c @@ -1,6 +1,11 @@ -/* - * 3.3.2 Send a Signal to a Process, P1003.1b-1993, p. 68 +/** + * @file * + * @brief Send a Signal to a Process + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/kill_r.c b/cpukit/posix/src/kill_r.c index 301c0603cf..739fed7358 100644 --- a/cpukit/posix/src/kill_r.c +++ b/cpukit/posix/src/kill_r.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Send a Signal to a Process + * @ingroup POSIX + */ + /* * 3.3.2 Send a Signal to a Process, P1003.1b-1993, p. 68 * diff --git a/cpukit/posix/src/killinfo.c b/cpukit/posix/src/killinfo.c index 95a2459100..b7b556de39 100644 --- a/cpukit/posix/src/killinfo.c +++ b/cpukit/posix/src/killinfo.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Send a Signal to a Process + * @ingroup POSIX + */ + /* * kill() support routine * diff --git a/cpukit/posix/src/lio_listio.c b/cpukit/posix/src/lio_listio.c index 235e689a63..9b53b4d858 100644 --- a/cpukit/posix/src/lio_listio.c +++ b/cpukit/posix/src/lio_listio.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Initiates a List of I/O Requests with Single Function Call + * @ingroup POSIX + */ + /* * 6.7.4 List Directed I/O, P1003.1b-1993, p. 158 * diff --git a/cpukit/posix/src/mqueue.c b/cpukit/posix/src/mqueue.c index 689de26c62..93d6f1bc5b 100644 --- a/cpukit/posix/src/mqueue.c +++ b/cpukit/posix/src/mqueue.c @@ -1,16 +1,11 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] - * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. +/** + * @file * + * @brief Initializes message_queue Manager Related Data Structures + * @ingroup POSIX_MQUEUE_P Message Queues Private Support Information + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/mqueueclose.c b/cpukit/posix/src/mqueueclose.c index 7fe1cebd33..8492c90705 100644 --- a/cpukit/posix/src/mqueueclose.c +++ b/cpukit/posix/src/mqueueclose.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function closes the Message Queue + * @ingroup POSIX + */ + /* * NOTE: The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message diff --git a/cpukit/posix/src/mqueuedeletesupp.c b/cpukit/posix/src/mqueuedeletesupp.c index 3c06a59e8a..1a7246278a 100644 --- a/cpukit/posix/src/mqueuedeletesupp.c +++ b/cpukit/posix/src/mqueuedeletesupp.c @@ -1,16 +1,11 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] - * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. +/** + * @file * + * @brief POSIX Delete Message Queue + * @ingroup POSIX_MQUEUE + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * @@ -41,10 +36,6 @@ #include <rtems/bspIo.h> #endif -/* - * _POSIX_Message_queue_Delete - */ - void _POSIX_Message_queue_Delete( POSIX_Message_queue_Control *the_mq ) diff --git a/cpukit/posix/src/mqueuegetattr.c b/cpukit/posix/src/mqueuegetattr.c index 267eed1951..cfcc51af1e 100644 --- a/cpukit/posix/src/mqueuegetattr.c +++ b/cpukit/posix/src/mqueuegetattr.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Message Queue Attributes + * @ingroup POSIX + */ + /* * NOTE: The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message diff --git a/cpukit/posix/src/mqueuenotify.c b/cpukit/posix/src/mqueuenotify.c index 9909fae4fa..5387335c33 100644 --- a/cpukit/posix/src/mqueuenotify.c +++ b/cpukit/posix/src/mqueuenotify.c @@ -1,16 +1,11 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] - * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. +/** + * @file * + * @brief Notify Process that a Message is Available on a Queue + * @ingroup POSIX_MQUEUE + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -57,11 +52,6 @@ static void _POSIX_Message_queue_Notify_handler( _CORE_message_queue_Set_notify( &the_mq->Message_queue, NULL, NULL ); } -/* - * 15.2.6 Notify Process that a Message is Available on a Queue, - * P1003.1b-1993, p. 280 - */ - int mq_notify( mqd_t mqdes, const struct sigevent *notification diff --git a/cpukit/posix/src/mqueueopen.c b/cpukit/posix/src/mqueueopen.c index b822978bc9..d5f783990e 100644 --- a/cpukit/posix/src/mqueueopen.c +++ b/cpukit/posix/src/mqueueopen.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Creates a new POSIX Message Queue or Opens an Existing Queue + * @ingroup POSIX + */ + /* * NOTE: The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message diff --git a/cpukit/posix/src/mqueuereceive.c b/cpukit/posix/src/mqueuereceive.c index 44defc250f..c5f9257747 100644 --- a/cpukit/posix/src/mqueuereceive.c +++ b/cpukit/posix/src/mqueuereceive.c @@ -1,16 +1,11 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] - * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. +/** + * @file * + * @brief Receive a Message From a Message Queue + * @ingroup POSIX_MQUEUE + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -37,12 +32,6 @@ #include <rtems/posix/mqueue.h> #include <rtems/posix/time.h> -/* - * 15.2.5 Receive a Message From a Message Queue, P1003.1b-1993, p. 279 - * - * NOTE: P1003.4b/D8, p. 45 adds mq_timedreceive(). - */ - ssize_t mq_receive( mqd_t mqdes, char *msg_ptr, diff --git a/cpukit/posix/src/mqueuerecvsupp.c b/cpukit/posix/src/mqueuerecvsupp.c index f1c3102e1f..5cfce067c6 100644 --- a/cpukit/posix/src/mqueuerecvsupp.c +++ b/cpukit/posix/src/mqueuerecvsupp.c @@ -1,16 +1,11 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] - * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. +/** + * @file * + * @brief POSIX Message Queue Receive Support + * @ingroup POSIX_MQUEUE_P Message Queues Private Support Information + */ + +/* * COPYRIGHT (c) 1989-2011. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/mqueuesend.c b/cpukit/posix/src/mqueuesend.c index 9448dbbe7b..0d67b6d337 100644 --- a/cpukit/posix/src/mqueuesend.c +++ b/cpukit/posix/src/mqueuesend.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Adds Message Pointed by msg_ptr to Message Queue Reffered by mqdes + * @ingroup POSIX + */ + /* * NOTE: The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message diff --git a/cpukit/posix/src/mqueuesendsupp.c b/cpukit/posix/src/mqueuesendsupp.c index dc70c471e0..3fbe0fb164 100644 --- a/cpukit/posix/src/mqueuesendsupp.c +++ b/cpukit/posix/src/mqueuesendsupp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Message Queue and Send Support + * @ingroup POSIX + */ + /* * NOTE: The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message diff --git a/cpukit/posix/src/mqueuesetattr.c b/cpukit/posix/src/mqueuesetattr.c index 7abdceb730..2fbcd95e3f 100644 --- a/cpukit/posix/src/mqueuesetattr.c +++ b/cpukit/posix/src/mqueuesetattr.c @@ -1,16 +1,11 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] - * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. +/** + * @file * + * @brief Set Message Queue Attributes + * @ingroup POSIX_MQUEUE + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -37,10 +32,6 @@ #include <rtems/posix/mqueue.h> #include <rtems/posix/time.h> -/* - * 15.2.7 Set Message Queue Attributes, P1003.1b-1993, p. 281 - */ - int mq_setattr( mqd_t mqdes, const struct mq_attr *mqstat, diff --git a/cpukit/posix/src/mqueuetimedreceive.c b/cpukit/posix/src/mqueuetimedreceive.c index ba79ce16d9..58f796160c 100644 --- a/cpukit/posix/src/mqueuetimedreceive.c +++ b/cpukit/posix/src/mqueuetimedreceive.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Receive Message from Message Queue + * @ingroup POSIX + */ + /* * NOTE: The structure of the routines is identical to that of POSIX * Message_queues to leave the option of having unnamed message diff --git a/cpukit/posix/src/mqueuetimedsend.c b/cpukit/posix/src/mqueuetimedsend.c index f06197fa79..da7e0e1058 100644 --- a/cpukit/posix/src/mqueuetimedsend.c +++ b/cpukit/posix/src/mqueuetimedsend.c @@ -1,15 +1,8 @@ -/* - * NOTE: The structure of the routines is identical to that of POSIX - * Message_queues to leave the option of having unnamed message - * queues at a future date. They are currently not part of the - * POSIX standard but unnamed message_queues are. This is also - * the reason for the apparently unnecessary tracking of - * the process_shared attribute. [In addition to the fact that - * it would be trivial to add pshared to the mq_attr structure - * and have process private message queues.] +/** + * @file * - * This code ignores the O_RDONLY/O_WRONLY/O_RDWR flag at open - * time. + * @brief Send a Message to a Message Queue + * @ingroup POSIX_MQUEUE */ /* @@ -39,12 +32,6 @@ #include <rtems/posix/mqueue.h> #include <rtems/posix/time.h> -/* - * 15.2.4 Send a Message to a Message Queue, P1003.1b-1993, p. 277 - * - * NOTE: P1003.4b/D8, p. 45 adds mq_timedsend(). - */ - int mq_timedsend( mqd_t mqdes, const char *msg_ptr, diff --git a/cpukit/posix/src/mqueuetranslatereturncode.c b/cpukit/posix/src/mqueuetranslatereturncode.c index b088eef179..34edf80a24 100644 --- a/cpukit/posix/src/mqueuetranslatereturncode.c +++ b/cpukit/posix/src/mqueuetranslatereturncode.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Error Translation in Message Queue + * @ingroup POSIX + */ + /* * POSIX Message Queue Error Translation * diff --git a/cpukit/posix/src/mutex.c b/cpukit/posix/src/mutex.c index fd9fed3f77..c6026e08d7 100644 --- a/cpukit/posix/src/mutex.c +++ b/cpukit/posix/src/mutex.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Mutex Manager Initialization + * @ingroup POSIX_MUTEX POSIX Mutex Support + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrdestroy.c b/cpukit/posix/src/mutexattrdestroy.c index d7a6616908..06d5c1d2fc 100644 --- a/cpukit/posix/src/mutexattrdestroy.c +++ b/cpukit/posix/src/mutexattrdestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Destroy Mutex Attributes Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -21,10 +28,9 @@ #include <rtems/posix/priority.h> #include <rtems/posix/time.h> -/* - * 11.3.1 Mutex Initialization Attributes, P1003.1c/Draft 10, p. 81 +/** + * 11.3.1 Mutex Initialization Attributes, P1003.1c/Draft 10, p. 81 */ - int pthread_mutexattr_destroy( pthread_mutexattr_t *attr ) diff --git a/cpukit/posix/src/mutexattrgetprotocol.c b/cpukit/posix/src/mutexattrgetprotocol.c index 584a38085b..1824b3fff9 100644 --- a/cpukit/posix/src/mutexattrgetprotocol.c +++ b/cpukit/posix/src/mutexattrgetprotocol.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get protocol Attribute of Mutex Attribute Obect + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrgetpshared.c b/cpukit/posix/src/mutexattrgetpshared.c index beeae9bc87..d32ef838b6 100644 --- a/cpukit/posix/src/mutexattrgetpshared.c +++ b/cpukit/posix/src/mutexattrgetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Obtaining process-shared Attribute Value from the Attributes Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrgettype.c b/cpukit/posix/src/mutexattrgettype.c index 23d0bb875f..9137271d9d 100644 --- a/cpukit/posix/src/mutexattrgettype.c +++ b/cpukit/posix/src/mutexattrgettype.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function gets the Mutex Type Attribute + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrinit.c b/cpukit/posix/src/mutexattrinit.c index f2d66010a1..9e1345ee6d 100644 --- a/cpukit/posix/src/mutexattrinit.c +++ b/cpukit/posix/src/mutexattrinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Mutex Initialization Attribute + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -21,10 +28,9 @@ #include <rtems/posix/priority.h> #include <rtems/posix/time.h> -/* +/** * 11.3.1 Mutex Initialization Attributes, P1003.1c/Draft 10, p. 81 */ - int pthread_mutexattr_init( pthread_mutexattr_t *attr ) diff --git a/cpukit/posix/src/mutexattrsetprioceiling.c b/cpukit/posix/src/mutexattrsetprioceiling.c index f4c2da9b96..82c83cf80e 100644 --- a/cpukit/posix/src/mutexattrsetprioceiling.c +++ b/cpukit/posix/src/mutexattrsetprioceiling.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Mutex Initialization Scheduling Attributes + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrsetprotocol.c b/cpukit/posix/src/mutexattrsetprotocol.c index 1c51ad5f03..fc7c1afe74 100644 --- a/cpukit/posix/src/mutexattrsetprotocol.c +++ b/cpukit/posix/src/mutexattrsetprotocol.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Mutex Initialization Scheduling Attributes + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrsetpshared.c b/cpukit/posix/src/mutexattrsetpshared.c index 6f9f9b4f9a..87e8b52f2b 100644 --- a/cpukit/posix/src/mutexattrsetpshared.c +++ b/cpukit/posix/src/mutexattrsetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function sets Current pshared Attribute for Mutex Attributes Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexattrsettype.c b/cpukit/posix/src/mutexattrsettype.c index a005747718..861e616ad3 100644 --- a/cpukit/posix/src/mutexattrsettype.c +++ b/cpukit/posix/src/mutexattrsettype.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Set a Mutex Type + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexdestroy.c b/cpukit/posix/src/mutexdestroy.c index 56f65b3b8f..4a9f1e964a 100644 --- a/cpukit/posix/src/mutexdestroy.c +++ b/cpukit/posix/src/mutexdestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initializing and Destroying a Mutex + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexget.c b/cpukit/posix/src/mutexget.c index f1419034c3..44d1864118 100644 --- a/cpukit/posix/src/mutexget.c +++ b/cpukit/posix/src/mutexget.c @@ -1,6 +1,11 @@ -/* - * Convert POSIX Mutex ID to local object pointer +/** + * @file * + * @brief Convert POSIX Mutex ID to local object pointer + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/mutexgetprioceiling.c b/cpukit/posix/src/mutexgetprioceiling.c index a0390b99f5..21287e2c38 100644 --- a/cpukit/posix/src/mutexgetprioceiling.c +++ b/cpukit/posix/src/mutexgetprioceiling.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Returns the Current Priority Ceiling of the Mutex + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexinit.c b/cpukit/posix/src/mutexinit.c index 26e75538c5..5ef3485ee2 100644 --- a/cpukit/posix/src/mutexinit.c +++ b/cpukit/posix/src/mutexinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initialize a Mutex + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). @@ -21,11 +28,11 @@ #include <rtems/posix/priority.h> #include <rtems/posix/time.h> -/* - * 11.3.2 Initializing and Destroying a Mutex, P1003.1c/Draft 10, p. 87 +/** + * 11.3.2 Initializing and Destroying a Mutex, P1003.1c/Draft 10, p. 87 * - * NOTE: XXX Could be optimized so all the attribute error checking - * is not performed when attr is NULL. + * NOTE: XXX Could be optimized so all the attribute error checking + * is not performed when attr is NULL. */ int pthread_mutex_init( diff --git a/cpukit/posix/src/mutexlock.c b/cpukit/posix/src/mutexlock.c index 0e3125f06f..be5e4d56df 100644 --- a/cpukit/posix/src/mutexlock.c +++ b/cpukit/posix/src/mutexlock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Call to function enables locking of Mutex Object referenced by mutex + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexlocksupp.c b/cpukit/posix/src/mutexlocksupp.c index 299aaa162b..6b5d7bd92f 100644 --- a/cpukit/posix/src/mutexlocksupp.c +++ b/cpukit/posix/src/mutexlocksupp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Support Call to function Enables Locking of Mutex Object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutexsetprioceiling.c b/cpukit/posix/src/mutexsetprioceiling.c index d873805e21..b11c4570ab 100644 --- a/cpukit/posix/src/mutexsetprioceiling.c +++ b/cpukit/posix/src/mutexsetprioceiling.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Changes the Priority Ceiling of a Mutex and Releases it + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/mutextimedlock.c b/cpukit/posix/src/mutextimedlock.c index a8d258a8f8..442f3c6052 100644 --- a/cpukit/posix/src/mutextimedlock.c +++ b/cpukit/posix/src/mutextimedlock.c @@ -1,5 +1,8 @@ -/* - * Mutex Timed Lock +/** + * @file + * + * @brief Mutex Timed Lock + * @ingroup POSIX */ /* @@ -28,12 +31,11 @@ #include <rtems/posix/priority.h> #include <rtems/posix/time.h> -/* - * 11.3.3 Locking and Unlocking a Mutex, P1003.1c/Draft 10, p. 93 +/** + * 11.3.3 Locking and Unlocking a Mutex, P1003.1c/Draft 10, p. 93 * - * NOTE: P1003.4b/D8 adds pthread_mutex_timedlock(), p. 29 + * NOTE: P1003.4b/D8 adds pthread_mutex_timedlock(), p. 29 */ - int pthread_mutex_timedlock( pthread_mutex_t *mutex, const struct timespec *abstime diff --git a/cpukit/posix/src/mutextranslatereturncode.c b/cpukit/posix/src/mutextranslatereturncode.c index 53b5b0ee00..8c2d9af8ce 100644 --- a/cpukit/posix/src/mutextranslatereturncode.c +++ b/cpukit/posix/src/mutextranslatereturncode.c @@ -1,6 +1,11 @@ -/* - * POSIX Mutex Error Translation +/** + * @file * + * @brief POSIX Mutex Translate Core Mutex Return Code + * @ingroup POSIX_MUTEX + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -20,17 +25,6 @@ #include <rtems/score/coremutex.h> #include <rtems/posix/mutex.h> -/* - * _POSIX_Mutex_Translate_core_mutex_return_code - * - * Input parameters: - * the_mutex_status - mutex status code to translate - * - * Output parameters: - * status code - translated POSIX status code - * - */ - static int _POSIX_Mutex_Return_codes[CORE_MUTEX_STATUS_LAST + 1] = { 0, /* CORE_MUTEX_STATUS_SUCCESSFUL */ EBUSY, /* CORE_MUTEX_STATUS_UNSATISFIED_NOWAIT */ diff --git a/cpukit/posix/src/mutextrylock.c b/cpukit/posix/src/mutextrylock.c index 85b6da51a7..f398dc208a 100644 --- a/cpukit/posix/src/mutextrylock.c +++ b/cpukit/posix/src/mutextrylock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Try to Lock Mutex + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -24,12 +31,11 @@ #include <rtems/posix/priority.h> #include <rtems/posix/time.h> -/* - * 11.3.3 Locking and Unlocking a Mutex, P1003.1c/Draft 10, p. 93 +/** + * 11.3.3 Locking and Unlocking a Mutex, P1003.1c/Draft 10, p. 93 * - * NOTE: P1003.4b/D8 adds pthread_mutex_timedlock(), p. 29 + * NOTE: P1003.4b/D8 adds pthread_mutex_timedlock(), p. 29 */ - int pthread_mutex_trylock( pthread_mutex_t *mutex ) diff --git a/cpukit/posix/src/mutexunlock.c b/cpukit/posix/src/mutexunlock.c index ab0230f69a..75eaec73c1 100644 --- a/cpukit/posix/src/mutexunlock.c +++ b/cpukit/posix/src/mutexunlock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Locking and Unlocking a Mutex + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/nanosleep.c b/cpukit/posix/src/nanosleep.c index d97112605d..02abe55cec 100644 --- a/cpukit/posix/src/nanosleep.c +++ b/cpukit/posix/src/nanosleep.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Suspends Execution of calling thread until Time elaps + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/pause.c b/cpukit/posix/src/pause.c index 3a307d6e93..ee74f6746b 100644 --- a/cpukit/posix/src/pause.c +++ b/cpukit/posix/src/pause.c @@ -1,6 +1,11 @@ -/* - * 3.4.2 Suspend Process Execution, P1003.1b-1993, p. 81 +/** + * @file * + * @brief Suspend Process Execution + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -17,10 +22,9 @@ #include <signal.h> #include <unistd.h> -/* - * 3.4.2 Suspend Process Execution, P1003.1b-1993, p. 81 +/** + * 3.4.2 Suspend Process Execution, P1003.1b-1993, p. 81 */ - int pause( void ) { sigset_t all_signals; diff --git a/cpukit/posix/src/pbarrierdestroy.c b/cpukit/posix/src/pbarrierdestroy.c index a8f6ce3b5e..6b2e9d0bc9 100644 --- a/cpukit/posix/src/pbarrierdestroy.c +++ b/cpukit/posix/src/pbarrierdestroy.c @@ -1,6 +1,11 @@ -/* - * POSIX Barrier Manager -- Destroy a Barrier +/** + * @file * + * @brief Destroy a Barrier Object + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,21 +24,17 @@ #include <rtems/system.h> #include <rtems/posix/barrier.h> -/* - * pthread_barrier_destroy - * +/** * This directive allows a thread to delete a barrier specified by * the barrier id. The barrier is freed back to the inactive * barrier chain. * - * Input parameters: - * barrier - barrier id - * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @param[in] barrier is the barrier id + * + * @return This method returns 0 if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ - int pthread_barrier_destroy( pthread_barrier_t *barrier ) diff --git a/cpukit/posix/src/pbarrierinit.c b/cpukit/posix/src/pbarrierinit.c index 077d63289c..c3077cb903 100644 --- a/cpukit/posix/src/pbarrierinit.c +++ b/cpukit/posix/src/pbarrierinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Call to Function Enables Reinitializing of the Barrier + * @ingroup POSIX + */ + /* * POSIX Barrier Manager -- Initialize a Barrier Instance * diff --git a/cpukit/posix/src/pbarriertranslatereturncode.c b/cpukit/posix/src/pbarriertranslatereturncode.c index b7d1999d93..e8a53ec459 100644 --- a/cpukit/posix/src/pbarriertranslatereturncode.c +++ b/cpukit/posix/src/pbarriertranslatereturncode.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Translates POSIX Barrier Status Code + * @ingroup POSIX + */ + /* * Barrier Manager -- Translate SuperCore Status * diff --git a/cpukit/posix/src/pbarrierwait.c b/cpukit/posix/src/pbarrierwait.c index c5e73bcb26..0ad9634411 100644 --- a/cpukit/posix/src/pbarrierwait.c +++ b/cpukit/posix/src/pbarrierwait.c @@ -1,6 +1,11 @@ -/* - * POSIX Barrier Manager -- Wait at a Barrier +/** + * @file * + * @brief Wait at a Barrier + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,18 +24,14 @@ #include <rtems/system.h> #include <rtems/posix/barrier.h> -/* - * pthread_barrier_wait - * - * This directive allows a thread to wait at a barrier. +/** + * This directive allows a thread to wait at a barrier. * - * Input parameters: - * barrier - barrier id + * @param[in] barrier is the barrier id * - * Output parameters: - * 0 - if successful - * PTHREAD_BARRIER_SERIAL_THREAD - if successful - * error code - if unsuccessful + * @retval 0 if successful + * @retval PTHREAD_BARRIER_SERIAL_THREAD if successful + * @retval error_code if unsuccessful */ int pthread_barrier_wait( diff --git a/cpukit/posix/src/prwlockdestroy.c b/cpukit/posix/src/prwlockdestroy.c index 684e173e18..9b644ba943 100644 --- a/cpukit/posix/src/prwlockdestroy.c +++ b/cpukit/posix/src/prwlockdestroy.c @@ -1,6 +1,10 @@ -/* - * POSIX RWLock Manager -- Destroy a RWLock +/** + * @file * + * @brief Destroy a RWLock + * @ingroup POSIX + */ +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,21 +23,17 @@ #include <rtems/system.h> #include <rtems/posix/rwlock.h> -/* - * pthread_rwlock_destroy - * +/** * This directive allows a thread to delete a rwlock specified by * the rwlock id. The rwlock is freed back to the inactive * rwlock chain. * - * Input parameters: - * rwlock - rwlock id + * @param[in] rwlock is the rwlock id * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @return This method returns 0 if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ - int pthread_rwlock_destroy( pthread_rwlock_t *rwlock ) diff --git a/cpukit/posix/src/prwlockinit.c b/cpukit/posix/src/prwlockinit.c index 2cba7d66aa..61825fe1d5 100644 --- a/cpukit/posix/src/prwlockinit.c +++ b/cpukit/posix/src/prwlockinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Allocate resources to use the read-write lock and Initialize it + * @ingroup POSIX + */ + /* * POSIX RWLock Manager -- Destroy a RWLock Instance * diff --git a/cpukit/posix/src/prwlockrdlock.c b/cpukit/posix/src/prwlockrdlock.c index ec75fea823..0ce4764915 100644 --- a/cpukit/posix/src/prwlockrdlock.c +++ b/cpukit/posix/src/prwlockrdlock.c @@ -1,6 +1,11 @@ -/* - * POSIX RWLock Manager -- Obtain a Read Lock on a RWLock Instance +/** + * @file * + * @brief Obtain a Read Lock on a RWLock Instance + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,17 +24,13 @@ #include <rtems/system.h> #include <rtems/posix/rwlock.h> -/* - * pthread_rwlock_rdlock - * - * This directive attempts to obtain a read only lock on an rwlock instance. +/** + * This directive attempts to obtain a read only lock on an rwlock instance. * - * Input parameters: - * rwlock - pointer to rwlock id + * @param[in] rwlock is the pointer to rwlock id * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @retval 0 if successful + * @retval error_code if unsuccessful */ int pthread_rwlock_rdlock( diff --git a/cpukit/posix/src/prwlocktimedrdlock.c b/cpukit/posix/src/prwlocktimedrdlock.c index 6bb397ad11..95a3fa5423 100644 --- a/cpukit/posix/src/prwlocktimedrdlock.c +++ b/cpukit/posix/src/prwlocktimedrdlock.c @@ -1,6 +1,11 @@ -/* - * POSIX RWLock Manager -- Attempt to Obtain a Read Lock on a RWLock Instance +/** + * @file * + * @brief Attempt to Obtain a Read Lock on a RWLock Instance + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/prwlocktimedwrlock.c b/cpukit/posix/src/prwlocktimedwrlock.c index 5e6e4ba419..ca435373ff 100644 --- a/cpukit/posix/src/prwlocktimedwrlock.c +++ b/cpukit/posix/src/prwlocktimedwrlock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function applies a Write lock to RWLock referenced by rwlock + * @ingroup POSIX + */ + /* * POSIX RWLock Manager -- Attempt to Obtain a Write Lock on a RWLock Instance * diff --git a/cpukit/posix/src/prwlocktranslatereturncode.c b/cpukit/posix/src/prwlocktranslatereturncode.c index 3c75e10aa4..48be176d36 100644 --- a/cpukit/posix/src/prwlocktranslatereturncode.c +++ b/cpukit/posix/src/prwlocktranslatereturncode.c @@ -1,6 +1,11 @@ -/* - * RWLock Manager -- Translate SuperCore Status +/** + * @file * + * @brief POSIX RWLock Translate Core RWLock Return Code + * @ingroup POSIX_RWLOCK + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,17 +24,6 @@ #include <rtems/system.h> #include <rtems/posix/rwlock.h> -/* - * _POSIX_RWLock_Translate_core_rwlock_return_code - * - * Input parameters: - * the_rwlock_status - rwlock status code to translate - * - * Output parameters: - * status code - translated POSIX status code - * - */ - static int _POSIX_RWLock_Return_codes[CORE_RWLOCK_STATUS_LAST + 1] = { 0, /* CORE_RWLOCK_SUCCESSFUL */ EINVAL, /* CORE_RWLOCK_DELETED */ diff --git a/cpukit/posix/src/prwlocktryrdlock.c b/cpukit/posix/src/prwlocktryrdlock.c index eb8c5f8f05..f8524e34d2 100644 --- a/cpukit/posix/src/prwlocktryrdlock.c +++ b/cpukit/posix/src/prwlocktryrdlock.c @@ -1,6 +1,11 @@ -/* - * POSIX RWLock Manager -- Attempt to Obtain a Read Lock on a RWLock Instance +/** + * @file * + * @brief Attempt to Obtain a Read Lock on a RWLock Instance + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/prwlockunlock.c b/cpukit/posix/src/prwlockunlock.c index 86f26d7a23..79042b259d 100644 --- a/cpukit/posix/src/prwlockunlock.c +++ b/cpukit/posix/src/prwlockunlock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Releases a lock held on RWLock object referenced by rwlock + * @ingroup POSIX + */ + /* * POSIX RWLock Manager -- Release a lock held on a RWLock Instance * diff --git a/cpukit/posix/src/prwlockwrlock.c b/cpukit/posix/src/prwlockwrlock.c index fffdbea3a8..16e5ecd6f1 100644 --- a/cpukit/posix/src/prwlockwrlock.c +++ b/cpukit/posix/src/prwlockwrlock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Obtain a Write Lock on a RWlock Instance + * @ingroup POSIX + */ + /* * POSIX RWLock Manager -- Obtain a Write Lock on a RWLock Instance * diff --git a/cpukit/posix/src/psignal.c b/cpukit/posix/src/psignal.c index 7623920f54..e490877d32 100644 --- a/cpukit/posix/src/psignal.c +++ b/cpukit/posix/src/psignal.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Signals Manager Initialization + * @ingroup POSIX_SIGNALS + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). @@ -162,10 +169,6 @@ API_extensions_Post_switch_control _POSIX_signals_Post_switch = { .hook = _POSIX_signals_Post_switch_hook }; -/* - * _POSIX_signals_Manager_Initialization - */ - void _POSIX_signals_Manager_Initialization(void) { uint32_t signo; diff --git a/cpukit/posix/src/psignalchecksignal.c b/cpukit/posix/src/psignalchecksignal.c index 171d7c8121..57237d3055 100644 --- a/cpukit/posix/src/psignalchecksignal.c +++ b/cpukit/posix/src/psignalchecksignal.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Signals Check Signal + * @ingroup POSIX_SIGNALS + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -31,11 +38,6 @@ #include <rtems/posix/time.h> #include <stdio.h> - -/* - * _POSIX_signals_Check_signal - */ - bool _POSIX_signals_Check_signal( POSIX_API_Control *api, int signo, diff --git a/cpukit/posix/src/psignalclearprocesssignals.c b/cpukit/posix/src/psignalclearprocesssignals.c index 3c3cdf4e68..3d1d16b5aa 100644 --- a/cpukit/posix/src/psignalclearprocesssignals.c +++ b/cpukit/posix/src/psignalclearprocesssignals.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX_signals clear_process_signals + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/psignalclearsignals.c b/cpukit/posix/src/psignalclearsignals.c index 390bcd1579..e71f2fa575 100644 --- a/cpukit/posix/src/psignalclearsignals.c +++ b/cpukit/posix/src/psignalclearsignals.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Signals Clear Signals + * @ingroup POSIX_SIGNALS POSIX Signals Support + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/psignalsetprocesssignals.c b/cpukit/posix/src/psignalsetprocesssignals.c index 22609bf2af..92c1d8164e 100644 --- a/cpukit/posix/src/psignalsetprocesssignals.c +++ b/cpukit/posix/src/psignalsetprocesssignals.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Signals Set Process Signals + * @ingroup POSIX_SIGNALS + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -27,10 +34,6 @@ #include <rtems/posix/time.h> #include <stdio.h> -/* - * _POSIX_signals_Set_process_signals - */ - void _POSIX_signals_Set_process_signals( sigset_t mask ) diff --git a/cpukit/posix/src/psignalunblockthread.c b/cpukit/posix/src/psignalunblockthread.c index 5dc6ef587b..0603a7f152 100644 --- a/cpukit/posix/src/psignalunblockthread.c +++ b/cpukit/posix/src/psignalunblockthread.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Signals Thread Unlock + * @ingroup POSIX_SIGNALS + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -27,12 +34,6 @@ #include <rtems/posix/time.h> #include <stdio.h> - -/* - * _POSIX_signals_Unblock_thread - */ - -/* XXX this routine could probably be cleaned up */ bool _POSIX_signals_Unblock_thread( Thread_Control *the_thread, int signo, diff --git a/cpukit/posix/src/pspindestroy.c b/cpukit/posix/src/pspindestroy.c index c5574c0c7b..97745b6b77 100644 --- a/cpukit/posix/src/pspindestroy.c +++ b/cpukit/posix/src/pspindestroy.c @@ -1,6 +1,11 @@ -/* - * POSIX Spinlock Manager -- Destroy a Spinlock +/** + * @file * + * @brief Destroy a Spinlock + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,21 +24,17 @@ #include <rtems/system.h> #include <rtems/posix/spinlock.h> -/* - * pthread_spin_destroy - * +/** * This directive allows a thread to delete a spinlock specified by * the spinlock id. The spinlock is freed back to the inactive * spinlock chain. * - * Input parameters: - * spinlock - spinlock id + * @param[in] spinlock is the spinlock id * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @return This method returns 0 if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ - int pthread_spin_destroy( pthread_spinlock_t *spinlock ) diff --git a/cpukit/posix/src/pspininit.c b/cpukit/posix/src/pspininit.c index 4a1019abaa..030bb50ae2 100644 --- a/cpukit/posix/src/pspininit.c +++ b/cpukit/posix/src/pspininit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Function Initializes a Spinlock Instance + * @ingroup POSIX + */ + /* * POSIX Spinlock Manager -- Initialize a Spinlock Instance * diff --git a/cpukit/posix/src/pspinlock.c b/cpukit/posix/src/pspinlock.c index ce1a2bb3c5..7f6793c1d5 100644 --- a/cpukit/posix/src/pspinlock.c +++ b/cpukit/posix/src/pspinlock.c @@ -1,6 +1,11 @@ -/* - * POSIX Spinlock Manager -- Wait at a Spinlock +/** + * @file * + * @brief Wait at a Spinlock + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,19 +24,15 @@ #include <rtems/system.h> #include <rtems/posix/spinlock.h> -/* - * pthread_spin_lock - * +/** * This directive allows a thread to wait at a spinlock. * - * Input parameters: - * spinlock - spinlock id - * - * Output parameters: - * 0 - if successful - * error code - if unsuccessful + * @param[in] spinlock is spinlock id + * + * @return This method returns 0 if there was not an + * error. Otherwise, a status code is returned indicating the + * source of the error. */ - int pthread_spin_lock( pthread_spinlock_t *spinlock ) diff --git a/cpukit/posix/src/pspinlocktranslatereturncode.c b/cpukit/posix/src/pspinlocktranslatereturncode.c index 92dca9101a..ce133a40b7 100644 --- a/cpukit/posix/src/pspinlocktranslatereturncode.c +++ b/cpukit/posix/src/pspinlocktranslatereturncode.c @@ -1,6 +1,11 @@ -/* - * Spinlock Manager -- Translate SuperCore Status +/** + * @file * + * @brief POSIX Spinlock Translate Core Spinlock Return Code + * @ingroup POSIX_SPINLOCK + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -20,17 +25,6 @@ #include <rtems/score/corespinlock.h> #include <rtems/posix/spinlock.h> -/* - * _POSIX_Spinlock_Translate_core_spinlock_return_code - * - * Input parameters: - * the_spinlock_status - spinlock status code to translate - * - * Output parameters: - * status code - translated POSIX status code - * - */ - static int _POSIX_Spinlock_Return_codes[CORE_SPINLOCK_STATUS_LAST + 1] = { 0, /* CORE_SPINLOCK_SUCCESSFUL */ EDEADLK, /* CORE_SPINLOCK_HOLDER_RELOCKING */ diff --git a/cpukit/posix/src/pspinunlock.c b/cpukit/posix/src/pspinunlock.c index 4fb1391977..67a69cbc02 100644 --- a/cpukit/posix/src/pspinunlock.c +++ b/cpukit/posix/src/pspinunlock.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Unlocks a Spin Lock Object + * @ingroup POSIX + */ + /* * POSIX Spinlock Manager -- Wait at a Spinlock * diff --git a/cpukit/posix/src/psxnametoid.c b/cpukit/posix/src/psxnametoid.c index f35eed3cc4..d75d5d43df 100644 --- a/cpukit/posix/src/psxnametoid.c +++ b/cpukit/posix/src/psxnametoid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Name to ID + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/psxpriorityisvalid.c b/cpukit/posix/src/psxpriorityisvalid.c index 3ef7a1ec26..eda424e420 100644 --- a/cpukit/posix/src/psxpriorityisvalid.c +++ b/cpukit/posix/src/psxpriorityisvalid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Is Priority Valid + * @ingroup POSIX_PRIORITY + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/psxtransschedparam.c b/cpukit/posix/src/psxtransschedparam.c index 059a7fb728..3c42ee15e3 100644 --- a/cpukit/posix/src/psxtransschedparam.c +++ b/cpukit/posix/src/psxtransschedparam.c @@ -1,4 +1,12 @@ -/* COPYRIGHT (c) 1989-2009. +/** + * @file + * + * @brief Translate sched_param into SuperCore Terms + * @ingroup POSIX_PTHREAD Private POSIX Threads + */ + +/* + * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * * The license and distribution terms for this file may be diff --git a/cpukit/posix/src/pthread.c b/cpukit/posix/src/pthread.c index 1773c24b69..873449a2da 100644 --- a/cpukit/posix/src/pthread.c +++ b/cpukit/posix/src/pthread.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Private Support Information for POSIX Threads + * @ingroup POSIX_PTHREADS Private Threads + */ + /* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/pthreadatfork.c b/cpukit/posix/src/pthreadatfork.c index 767f113d0c..558bc77555 100644 --- a/cpukit/posix/src/pthreadatfork.c +++ b/cpukit/posix/src/pthreadatfork.c @@ -1,15 +1,11 @@ -/* - * pthread_atfork() - POSIX 1003.1b 3.1.3 - * - * 3.1.3 Register Fork Handlers, P1003.1c/Draft 10, P1003.1c/Draft 10, p. 27 - * - * RTEMS does not support processes, so we fall under this and do not - * provide this routine: - * - * "Either the implementation shall support the pthread_atfork() function - * as described above or the pthread_atfork() funciton shall not be - * provided." +/** + * @file * + * @brief Register Fork Handlers + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -27,6 +23,18 @@ #include <errno.h> #include <rtems/seterr.h> +/** + * POSIX 1003.1b 3.1.3 + * + * 3.1.3 Register Fork Handlers, P1003.1c/Draft 10, P1003.1c/Draft 10, p. 27 + * + * RTEMS does not support processes, so we fall under this and do not + * provide this routine: + * + * "Either the implementation shall support the pthread_atfork() function + * as described above or the pthread_atfork() funciton shall not be + * provided." + */ int pthread_atfork( void (*prepare)(void) __attribute__((unused)), void (*parent)(void) __attribute__((unused)), diff --git a/cpukit/posix/src/pthreadattrdestroy.c b/cpukit/posix/src/pthreadattrdestroy.c index 0852b29ec7..27d58ccec7 100644 --- a/cpukit/posix/src/pthreadattrdestroy.c +++ b/cpukit/posix/src/pthreadattrdestroy.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 +/** + * @file * + * @brief Thread Creation Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrgetdetachstate.c b/cpukit/posix/src/pthreadattrgetdetachstate.c index e9b225d23c..bd23cb7f30 100644 --- a/cpukit/posix/src/pthreadattrgetdetachstate.c +++ b/cpukit/posix/src/pthreadattrgetdetachstate.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function gets the detachstate Attribute in the attr Object + * @ingroup POSIX + */ + /* * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 * diff --git a/cpukit/posix/src/pthreadattrgetguardsize.c b/cpukit/posix/src/pthreadattrgetguardsize.c index 72211cdf9a..81eee4f9f9 100644 --- a/cpukit/posix/src/pthreadattrgetguardsize.c +++ b/cpukit/posix/src/pthreadattrgetguardsize.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes +/** + * @file * + * @brief Thread Creation Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrgetinheritsched.c b/cpukit/posix/src/pthreadattrgetinheritsched.c index ae564650e6..84f1fa560f 100644 --- a/cpukit/posix/src/pthreadattrgetinheritsched.c +++ b/cpukit/posix/src/pthreadattrgetinheritsched.c @@ -1,6 +1,11 @@ -/* - * 13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120 +/** + * @file * + * @brief Thread Creation Scheduling Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrgetschedparam.c b/cpukit/posix/src/pthreadattrgetschedparam.c index 7ec55a305d..eee962f854 100644 --- a/cpukit/posix/src/pthreadattrgetschedparam.c +++ b/cpukit/posix/src/pthreadattrgetschedparam.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Returns Scheduling Parameter Attributes of Thread Attributes Object + * @ingroup POSIX + */ + /* * 13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120 * diff --git a/cpukit/posix/src/pthreadattrgetschedpolicy.c b/cpukit/posix/src/pthreadattrgetschedpolicy.c index 1a79711fb2..6b57e8a2ca 100644 --- a/cpukit/posix/src/pthreadattrgetschedpolicy.c +++ b/cpukit/posix/src/pthreadattrgetschedpolicy.c @@ -1,6 +1,11 @@ -/* - * 13.5.1 Thread Creation Scheduling Parameters, P1003.1c/Draft 10, p. 120 +/** + * @file * + * @brief Get The Schedpolicy Attribute + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -16,6 +21,9 @@ #include <pthread.h> #include <errno.h> +/** + * 13.5.1 Thread Creation Scheduling Parameters, P1003.1c/Draft 10, p. 120 + */ int pthread_attr_getschedpolicy( const pthread_attr_t *attr, int *policy diff --git a/cpukit/posix/src/pthreadattrgetscope.c b/cpukit/posix/src/pthreadattrgetscope.c index e7eb7f8344..ee5ed4c044 100644 --- a/cpukit/posix/src/pthreadattrgetscope.c +++ b/cpukit/posix/src/pthreadattrgetscope.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function gets the Contentionscope Attribute in the attr object + * @ingroup POSIX + */ + /* * 13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120 * diff --git a/cpukit/posix/src/pthreadattrgetstack.c b/cpukit/posix/src/pthreadattrgetstack.c index e035ee4b62..a1254ae7a1 100644 --- a/cpukit/posix/src/pthreadattrgetstack.c +++ b/cpukit/posix/src/pthreadattrgetstack.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Gets the Thread Creation Stack Attributes in the attr + * @ingroup POSIX + */ + /* * 16.1.1 Thread Creation Attributes * diff --git a/cpukit/posix/src/pthreadattrgetstackaddr.c b/cpukit/posix/src/pthreadattrgetstackaddr.c index c877c1395d..dfdffbd662 100644 --- a/cpukit/posix/src/pthreadattrgetstackaddr.c +++ b/cpukit/posix/src/pthreadattrgetstackaddr.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 +/** + * @file * + * @brief Thread Creation Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrgetstacksize.c b/cpukit/posix/src/pthreadattrgetstacksize.c index 9827933c51..06854ca54b 100644 --- a/cpukit/posix/src/pthreadattrgetstacksize.c +++ b/cpukit/posix/src/pthreadattrgetstacksize.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 +/** + * @file * + * @brief Thread Creation Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrinit.c b/cpukit/posix/src/pthreadattrinit.c index 67942c8ac4..1e5211bfd6 100644 --- a/cpukit/posix/src/pthreadattrinit.c +++ b/cpukit/posix/src/pthreadattrinit.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 +/** + * @file * + * @brief Thread Attributes Creation + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -19,6 +24,9 @@ #include <rtems/system.h> #include <rtems/posix/pthread.h> +/** + * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 + */ int pthread_attr_init( pthread_attr_t *attr ) diff --git a/cpukit/posix/src/pthreadattrsetdetachstate.c b/cpukit/posix/src/pthreadattrsetdetachstate.c index e10d663815..a76d304a43 100644 --- a/cpukit/posix/src/pthreadattrsetdetachstate.c +++ b/cpukit/posix/src/pthreadattrsetdetachstate.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 +/** + * @file * + * @brief Thread Creation Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrsetguardsize.c b/cpukit/posix/src/pthreadattrsetguardsize.c index 51390a7d12..7656d4fee9 100644 --- a/cpukit/posix/src/pthreadattrsetguardsize.c +++ b/cpukit/posix/src/pthreadattrsetguardsize.c @@ -1,6 +1,11 @@ -/* - * 16.1.1 Thread Creation Attributes +/** + * @file * + * @brief Thread Creation Attributes + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrsetinheritsched.c b/cpukit/posix/src/pthreadattrsetinheritsched.c index 65c43dd24a..2951444fcf 100644 --- a/cpukit/posix/src/pthreadattrsetinheritsched.c +++ b/cpukit/posix/src/pthreadattrsetinheritsched.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function sets the inheritsched Attribute in the attr Argument + * @ingroup POSIX + */ + /* * 13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120 * diff --git a/cpukit/posix/src/pthreadattrsetschedparam.c b/cpukit/posix/src/pthreadattrsetschedparam.c index fb56652db7..65e560198f 100644 --- a/cpukit/posix/src/pthreadattrsetschedparam.c +++ b/cpukit/posix/src/pthreadattrsetschedparam.c @@ -1,6 +1,11 @@ -/* - * 13.5.1 Thread Creation Scheduling Parameters, P1003.1c/Draft 10, p. 120 +/** + * @file * + * @brief Thread Creation Scheduling Parameters + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/pthreadattrsetschedpolicy.c b/cpukit/posix/src/pthreadattrsetschedpolicy.c index e095d719b9..ee7fe1fce3 100644 --- a/cpukit/posix/src/pthreadattrsetschedpolicy.c +++ b/cpukit/posix/src/pthreadattrsetschedpolicy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sets Scheduling policy Attributes of Thread Attributes Object + * @ingroup POSIX + */ + /* * 13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120 * diff --git a/cpukit/posix/src/pthreadattrsetscope.c b/cpukit/posix/src/pthreadattrsetscope.c index 53a00a268b..d468524086 100644 --- a/cpukit/posix/src/pthreadattrsetscope.c +++ b/cpukit/posix/src/pthreadattrsetscope.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Sets the Contentionscope Attribute in the attr Object + * @ingroup POSIX + */ + /* * 13.5.1 Thread Creation Scheduling Attributes, P1003.1c/Draft 10, p. 120 * diff --git a/cpukit/posix/src/pthreadattrsetstack.c b/cpukit/posix/src/pthreadattrsetstack.c index 3eb4181842..04231ed791 100644 --- a/cpukit/posix/src/pthreadattrsetstack.c +++ b/cpukit/posix/src/pthreadattrsetstack.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Sets Thread Creation Stack Attributes in the attr object + * @ingroup POSIX + */ + /* * 16.1.1 Thread Creation Attributes * diff --git a/cpukit/posix/src/pthreadattrsetstackaddr.c b/cpukit/posix/src/pthreadattrsetstackaddr.c index 3c3b2b05d3..1696bb95ac 100644 --- a/cpukit/posix/src/pthreadattrsetstackaddr.c +++ b/cpukit/posix/src/pthreadattrsetstackaddr.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sets the Thread Creation stackaddr Attribute in the attr Object + * @ingroup POSIX + */ + /* * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 * diff --git a/cpukit/posix/src/pthreadattrsetstacksize.c b/cpukit/posix/src/pthreadattrsetstacksize.c index d6a2050a53..eb269e3df9 100644 --- a/cpukit/posix/src/pthreadattrsetstacksize.c +++ b/cpukit/posix/src/pthreadattrsetstacksize.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sets the Thread Creation Stacksize Attribute in the attr object + * @ingroup POSIX + */ + /* * 16.1.1 Thread Creation Attributes, P1003.1c/Draft 10, p, 140 * diff --git a/cpukit/posix/src/pthreadcreate.c b/cpukit/posix/src/pthreadcreate.c index c320f40660..30551ac64c 100644 --- a/cpukit/posix/src/pthreadcreate.c +++ b/cpukit/posix/src/pthreadcreate.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Starts a New Thread in The Calling Process + * @ingroup POSIX + */ + /* * 16.1.2 Thread Creation, P1003.1c/Draft 10, p. 144 */ diff --git a/cpukit/posix/src/pthreaddetach.c b/cpukit/posix/src/pthreaddetach.c index a50aa86a4e..682bac8b42 100644 --- a/cpukit/posix/src/pthreaddetach.c +++ b/cpukit/posix/src/pthreaddetach.c @@ -1,6 +1,11 @@ -/* - * 16.1.4 Detaching a Thread, P1003.1c/Draft 10, p. 149 +/** + * @file * + * @brief Detaching a Thread + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -20,6 +25,9 @@ #include <rtems/score/thread.h> #include <rtems/posix/pthread.h> +/** + * 16.1.4 Detaching a Thread, P1003.1c/Draft 10, p. 149 + */ int pthread_detach( pthread_t thread ) diff --git a/cpukit/posix/src/pthreadequal.c b/cpukit/posix/src/pthreadequal.c index bc18e33a13..ce08b1ea88 100644 --- a/cpukit/posix/src/pthreadequal.c +++ b/cpukit/posix/src/pthreadequal.c @@ -1,6 +1,11 @@ -/* - * 16.1.7 Compare Thread IDs, p1003.1c/Draft 10, p. 153 +/** + * @file * + * @brief Compare Thread IDs + * @ingroup POSIX + */ + +/* * NOTE: POSIX does not define the behavior when either thread id is invalid. * * COPYRIGHT (c) 1989-2007. diff --git a/cpukit/posix/src/pthreadgetcpuclockid.c b/cpukit/posix/src/pthreadgetcpuclockid.c index 51776f046e..0b7e3bbd28 100644 --- a/cpukit/posix/src/pthreadgetcpuclockid.c +++ b/cpukit/posix/src/pthreadgetcpuclockid.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Returns Clock ID for CPU time clock of the thread + * @ingroup POSIX + */ + /* * 20.1.6 Accessing a Thread CPU-time Clock, P1003.4b/Draft 8, p. 58 * diff --git a/cpukit/posix/src/pthreadgetschedparam.c b/cpukit/posix/src/pthreadgetschedparam.c index 5311e3f5e0..8c78ccca52 100644 --- a/cpukit/posix/src/pthreadgetschedparam.c +++ b/cpukit/posix/src/pthreadgetschedparam.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Gets Scheduling Policy and Parameters of Individual Threads + * @ingroup POSIX + */ + /* * 13.5.2 Dynamic Thread Scheduling Parameters Access, * P1003.1c/Draft 10, p. 124 diff --git a/cpukit/posix/src/pthreadinitthreads.c b/cpukit/posix/src/pthreadinitthreads.c index b2c850fda2..8b17e06a14 100644 --- a/cpukit/posix/src/pthreadinitthreads.c +++ b/cpukit/posix/src/pthreadinitthreads.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Threads Initialize User Threads Body + * @ingroup POSIX_PTHREAD + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). @@ -28,17 +35,6 @@ #include <rtems/posix/key.h> #include <rtems/posix/time.h> -/* - * _POSIX_Threads_Initialize_user_threads_body - * - * This routine creates and starts all configured user - * initialization threads. - * - * Input parameters: NONE - * - * Output parameters: NONE - */ - void _POSIX_Threads_Initialize_user_threads_body(void) { int status; diff --git a/cpukit/posix/src/pthreadjoin.c b/cpukit/posix/src/pthreadjoin.c index ac48612505..115f39d103 100644 --- a/cpukit/posix/src/pthreadjoin.c +++ b/cpukit/posix/src/pthreadjoin.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Suspends Execution of Calling Thread until Target Thread Terminates + * @ingroup POSIX + */ + /* * 16.1.3 Wait for Thread Termination, P1003.1c/Draft 10, p. 147 * diff --git a/cpukit/posix/src/pthreadkill.c b/cpukit/posix/src/pthreadkill.c index 67ef0c7005..420aaa567f 100644 --- a/cpukit/posix/src/pthreadkill.c +++ b/cpukit/posix/src/pthreadkill.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sends a signal Asynchronously directed to a thread + * @ingroup POSIX + */ + /* * 3.3.10 Send a Signal to a Thread, P1003.1c/D10, p. 43 * diff --git a/cpukit/posix/src/pthreadonce.c b/cpukit/posix/src/pthreadonce.c index 5f598a787a..651e4d0539 100644 --- a/cpukit/posix/src/pthreadonce.c +++ b/cpukit/posix/src/pthreadonce.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Call to function by Thread will call init_routine with no Arguments + * @ingroup POSIX + */ + /* * 16.1.8 Dynamic Package Initialization, P1003.1c/Draft 10, p. 154 * diff --git a/cpukit/posix/src/pthreadself.c b/cpukit/posix/src/pthreadself.c index 9400b4b7fe..0ed68be515 100644 --- a/cpukit/posix/src/pthreadself.c +++ b/cpukit/posix/src/pthreadself.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function returns the ID of the Calling Thread + * @ingroup POSIX + */ + /* * 16.1.6 Get Calling Thread's ID, p1003.1c/Draft 10, p. 152 * diff --git a/cpukit/posix/src/pthreadsetschedparam.c b/cpukit/posix/src/pthreadsetschedparam.c index 231b4f930f..d574811ae0 100644 --- a/cpukit/posix/src/pthreadsetschedparam.c +++ b/cpukit/posix/src/pthreadsetschedparam.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function sets scheduling policy and parameters of the thread + * @ingroup POSIX + */ + /* * 13.5.2 Dynamic Thread Scheduling Parameters Access, * P1003.1c/Draft 10, p. 124 diff --git a/cpukit/posix/src/pthreadsigmask.c b/cpukit/posix/src/pthreadsigmask.c index b424daba78..9d47e44865 100644 --- a/cpukit/posix/src/pthreadsigmask.c +++ b/cpukit/posix/src/pthreadsigmask.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Examine and/or change the calling thread's signal mask + * @ingroup POSIX + */ + /* * 3.3.5 Examine and Change Blocked Signals, P1003.1b-1993, p. 73 * diff --git a/cpukit/posix/src/ptimer.c b/cpukit/posix/src/ptimer.c index 2e3526730a..1d5ac6245e 100644 --- a/cpukit/posix/src/ptimer.c +++ b/cpukit/posix/src/ptimer.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Process Timer + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/rwlockattrdestroy.c b/cpukit/posix/src/rwlockattrdestroy.c index 022fe79864..102b141704 100644 --- a/cpukit/posix/src/rwlockattrdestroy.c +++ b/cpukit/posix/src/rwlockattrdestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Destroys a read-write lock Attributes object + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/rwlockattrgetpshared.c b/cpukit/posix/src/rwlockattrgetpshared.c index 488809f87b..233cbffa22 100644 --- a/cpukit/posix/src/rwlockattrgetpshared.c +++ b/cpukit/posix/src/rwlockattrgetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get the Process-Shared Attribute of the RWLock + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -14,10 +21,6 @@ #include <pthread.h> #include <errno.h> -/* - * RWLock Attributes Get Process Shared - */ - int pthread_rwlockattr_getpshared( const pthread_rwlockattr_t *attr, int *pshared diff --git a/cpukit/posix/src/rwlockattrinit.c b/cpukit/posix/src/rwlockattrinit.c index ea88e002b2..381cd52b0d 100644 --- a/cpukit/posix/src/rwlockattrinit.c +++ b/cpukit/posix/src/rwlockattrinit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initialises a RWLock Attributes object attr with the default value + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/rwlockattrsetpshared.c b/cpukit/posix/src/rwlockattrsetpshared.c index f27a5b56fe..5a32530e1e 100644 --- a/cpukit/posix/src/rwlockattrsetpshared.c +++ b/cpukit/posix/src/rwlockattrsetpshared.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief RWLock Attributes Set Process Shared + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/sched_getparam.c b/cpukit/posix/src/sched_getparam.c index 9cd95fefbe..d9e516a8ed 100644 --- a/cpukit/posix/src/sched_getparam.c +++ b/cpukit/posix/src/sched_getparam.c @@ -1,6 +1,11 @@ -/* - * 13.3.2 Set Scheduling Parameters, P1003.1b-1993, p. 253 +/** + * @file * + * @brief Set Scheduling Parameters + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -19,6 +24,9 @@ #include <rtems/system.h> #include <rtems/seterr.h> +/** + * 13.3.2 Set Scheduling Parameters, P1003.1b-1993, p. 253 + */ int sched_getparam( pid_t pid __attribute__((unused)), struct sched_param *param __attribute__((unused)) diff --git a/cpukit/posix/src/sched_getprioritymax.c b/cpukit/posix/src/sched_getprioritymax.c index a85f02b250..5a77e258f1 100644 --- a/cpukit/posix/src/sched_getprioritymax.c +++ b/cpukit/posix/src/sched_getprioritymax.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Returns the Appropriate Maximum for Scheduling policy + * @ingroup POSIX + */ + /* * 13.3.6 Get Scheduling Parameter Limits, P1003.1b-1993, p. 258 * diff --git a/cpukit/posix/src/sched_getprioritymin.c b/cpukit/posix/src/sched_getprioritymin.c index ed5737e1bc..73d892de47 100644 --- a/cpukit/posix/src/sched_getprioritymin.c +++ b/cpukit/posix/src/sched_getprioritymin.c @@ -1,6 +1,11 @@ -/* - * 13.3.6 Get Scheduling Parameter Limits, P1003.1b-1993, p. 258 +/** + * @file * + * @brief Get the Minimum Priority Limit + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -20,6 +25,9 @@ #include <rtems/seterr.h> #include <rtems/posix/priority.h> +/** + * 13.3.6 Get Scheduling Parameter Limits, P1003.1b-1993, p. 258 + */ int sched_get_priority_min( int policy ) diff --git a/cpukit/posix/src/sched_getscheduler.c b/cpukit/posix/src/sched_getscheduler.c index 755b38e2a6..6f12cd7868 100644 --- a/cpukit/posix/src/sched_getscheduler.c +++ b/cpukit/posix/src/sched_getscheduler.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Returns Scheduling Policy of the process specified by pid + * @ingroup POSIX + */ + /* * 13.3.4 Get Scheduling Policy, P1003.1b-1993, p. 256 * diff --git a/cpukit/posix/src/sched_rr_get_interval.c b/cpukit/posix/src/sched_rr_get_interval.c index 5fb2774ccf..b73f60f229 100644 --- a/cpukit/posix/src/sched_rr_get_interval.c +++ b/cpukit/posix/src/sched_rr_get_interval.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Limits for Scheduling Parameter + * @ingroup POSIX + */ + /* * 13.3.6 Get Scheduling Parameter Limits, P1003.1b-1993, p. 258 * diff --git a/cpukit/posix/src/sched_setparam.c b/cpukit/posix/src/sched_setparam.c index d31a29fa14..8e894e0978 100644 --- a/cpukit/posix/src/sched_setparam.c +++ b/cpukit/posix/src/sched_setparam.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sets Scheduling Parameters Associated with Scheduling Policies + * @ingroup POSIX + */ + /* * 13.3.1 Set Scheduling Parameters, P1003.1b-1993, p. 252 * diff --git a/cpukit/posix/src/sched_setscheduler.c b/cpukit/posix/src/sched_setscheduler.c index fcbc8fd3fd..f9b5c3f562 100644 --- a/cpukit/posix/src/sched_setscheduler.c +++ b/cpukit/posix/src/sched_setscheduler.c @@ -1,7 +1,11 @@ -/* - * 13.3.3 Set Scheduling Policy and Scheduling Parameters, - * P1003.1b-1993, p. 254 +/** + * @file * + * @brief Set Scheduling Policy and Scheduling Parameters + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/sched_yield.c b/cpukit/posix/src/sched_yield.c index b2d61c53ce..1aa4713a85 100644 --- a/cpukit/posix/src/sched_yield.c +++ b/cpukit/posix/src/sched_yield.c @@ -1,6 +1,11 @@ -/* - * 13.3.5 Yield Processor, P1003.1b-1993, p. 257 +/** + * @file * + * @brief Yield Processor + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/semaphore.c b/cpukit/posix/src/semaphore.c index a64fe81206..b214a3c302 100644 --- a/cpukit/posix/src/semaphore.c +++ b/cpukit/posix/src/semaphore.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Function Initializes Semaphore Manager + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/semaphorecreatesupp.c b/cpukit/posix/src/semaphorecreatesupp.c index 6460da8526..18fef72a03 100644 --- a/cpukit/posix/src/semaphorecreatesupp.c +++ b/cpukit/posix/src/semaphorecreatesupp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function does Actual creation and Initialization of POSIX Semaphore + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/semaphoredeletesupp.c b/cpukit/posix/src/semaphoredeletesupp.c index 433c23cc7a..a24adef870 100644 --- a/cpukit/posix/src/semaphoredeletesupp.c +++ b/cpukit/posix/src/semaphoredeletesupp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Delete Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -25,10 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * _POSIX_Semaphore_Delete - */ - void _POSIX_Semaphore_Delete( POSIX_Semaphore_Control *the_semaphore ) diff --git a/cpukit/posix/src/semaphoretranslatereturncode.c b/cpukit/posix/src/semaphoretranslatereturncode.c index 2f1af1dd1b..2c54b9fb49 100644 --- a/cpukit/posix/src/semaphoretranslatereturncode.c +++ b/cpukit/posix/src/semaphoretranslatereturncode.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Semaphore Code Translation Error + * @ingroup POSIX + */ + /* * POSIX Semaphore Error Translation * diff --git a/cpukit/posix/src/semaphorewaitsupp.c b/cpukit/posix/src/semaphorewaitsupp.c index 2ad1efe5af..5b215dad23 100644 --- a/cpukit/posix/src/semaphorewaitsupp.c +++ b/cpukit/posix/src/semaphorewaitsupp.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Semaphore Wait Support + * @ingroup POSIX_SEMAPHORES Semaphore + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/semclose.c b/cpukit/posix/src/semclose.c index 3913cd57fb..a9521bdd6b 100644 --- a/cpukit/posix/src/semclose.c +++ b/cpukit/posix/src/semclose.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Close a Named Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -25,15 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> - -/* - * sem_close - * - * 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 ) diff --git a/cpukit/posix/src/semdestroy.c b/cpukit/posix/src/semdestroy.c index b2a03f5ff7..14ba520fa3 100644 --- a/cpukit/posix/src/semdestroy.c +++ b/cpukit/posix/src/semdestroy.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Destroy an Unnamed Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -25,10 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * 11.2.2 Destroy an Unnamed Semaphore, P1003.1b-1993, p.220 - */ - int sem_destroy( sem_t *sem ) diff --git a/cpukit/posix/src/semgetvalue.c b/cpukit/posix/src/semgetvalue.c index 7b21c82df9..8ea0bdad07 100644 --- a/cpukit/posix/src/semgetvalue.c +++ b/cpukit/posix/src/semgetvalue.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Get the Value of a Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -25,10 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * 11.2.8 Get the Value of a Semaphore, P1003.1b-1993, p.229 - */ - int sem_getvalue( sem_t *sem, int *sval diff --git a/cpukit/posix/src/seminit.c b/cpukit/posix/src/seminit.c index 42dd0405d1..be7056dcad 100644 --- a/cpukit/posix/src/seminit.c +++ b/cpukit/posix/src/seminit.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Initializing of an Unnamed Semaphore + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/semopen.c b/cpukit/posix/src/semopen.c index 3354369936..1ecd75105b 100644 --- a/cpukit/posix/src/semopen.c +++ b/cpukit/posix/src/semopen.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Creates New POSIX semaphore or Opens an existing Semaphore + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/sempost.c b/cpukit/posix/src/sempost.c index e1d6221ad7..7ce367986f 100644 --- a/cpukit/posix/src/sempost.c +++ b/cpukit/posix/src/sempost.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Unlock a Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -25,10 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * 11.2.7 Unlock a Semaphore, P1003.1b-1993, p.227 - */ - int sem_post( sem_t *sem ) diff --git a/cpukit/posix/src/semtimedwait.c b/cpukit/posix/src/semtimedwait.c index 33008366f5..9f54ad3add 100644 --- a/cpukit/posix/src/semtimedwait.c +++ b/cpukit/posix/src/semtimedwait.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Lock a Semaphore + * @ingroup POSIX_SEMAPHORE POSIX Semaphores Support + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/semtrywait.c b/cpukit/posix/src/semtrywait.c index e8c4e7689b..b80e515afd 100644 --- a/cpukit/posix/src/semtrywait.c +++ b/cpukit/posix/src/semtrywait.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Lock a Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). @@ -25,12 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * 11.2.6 Lock a Semaphore, P1003.1b-1993, p.226 - * - * NOTE: P1003.4b/D8 adds sem_timedwait(), p. 27 - */ - int sem_trywait( sem_t *sem ) diff --git a/cpukit/posix/src/semunlink.c b/cpukit/posix/src/semunlink.c index 16c9525e3f..c34add8131 100644 --- a/cpukit/posix/src/semunlink.c +++ b/cpukit/posix/src/semunlink.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Remove a Named Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). @@ -25,15 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * sem_unlink - * - * 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 ) diff --git a/cpukit/posix/src/semwait.c b/cpukit/posix/src/semwait.c index 32b896a4df..16fc9076d4 100644 --- a/cpukit/posix/src/semwait.c +++ b/cpukit/posix/src/semwait.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Lock a Semaphore + * @ingroup POSIX_SEMAPHORE + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). @@ -25,12 +32,6 @@ #include <rtems/posix/time.h> #include <rtems/seterr.h> -/* - * 11.2.6 Lock a Semaphore, P1003.1b-1993, p.226 - * - * NOTE: P1003.4b/D8 adds sem_timedwait(), p. 27 - */ - int sem_wait( sem_t *sem ) diff --git a/cpukit/posix/src/setcanceltype.c b/cpukit/posix/src/setcanceltype.c index c0278dd10a..6a82374229 100644 --- a/cpukit/posix/src/setcanceltype.c +++ b/cpukit/posix/src/setcanceltype.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Sets the Cancelability Type of Calling Thread to value given in type + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/setitimer.c b/cpukit/posix/src/setitimer.c index 7a40419463..f8ab9efa56 100644 --- a/cpukit/posix/src/setitimer.c +++ b/cpukit/posix/src/setitimer.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Set the Timer + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/sigaction.c b/cpukit/posix/src/sigaction.c index 9fb04a042d..b2906558e0 100644 --- a/cpukit/posix/src/sigaction.c +++ b/cpukit/posix/src/sigaction.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Allows calling process to examine action of a Specific Signal + * @ingroup POSIX + */ + /* * 3.3.4 Examine and Change Signal Action, P1003.1b-1993, p. 70 * diff --git a/cpukit/posix/src/sigaddset.c b/cpukit/posix/src/sigaddset.c index dac1cda520..d4e324fe5e 100644 --- a/cpukit/posix/src/sigaddset.c +++ b/cpukit/posix/src/sigaddset.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Adds Signal from Set + * @ingroup POSIX + */ + /* * 3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69 * diff --git a/cpukit/posix/src/sigdelset.c b/cpukit/posix/src/sigdelset.c index a559e64bbb..7567689ccd 100644 --- a/cpukit/posix/src/sigdelset.c +++ b/cpukit/posix/src/sigdelset.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Deleted Signal from Set + * @ingroup POSIX + */ + /* * 3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69 * diff --git a/cpukit/posix/src/sigfillset.c b/cpukit/posix/src/sigfillset.c index 75b0ede57e..32b1ef15d0 100644 --- a/cpukit/posix/src/sigfillset.c +++ b/cpukit/posix/src/sigfillset.c @@ -1,6 +1,11 @@ -/* - * 3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69 +/** + * @file * + * @brief Manipulate Signal Sets + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/sigismember.c b/cpukit/posix/src/sigismember.c index 545df3ec28..5591085af4 100644 --- a/cpukit/posix/src/sigismember.c +++ b/cpukit/posix/src/sigismember.c @@ -1,6 +1,11 @@ -/* - * 3.3.3 Manipulate Signal Sets, P1003.1b-1993, p. 69 +/** + * @file * + * @brief Manipulate Signal Sets + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/signal_2.c b/cpukit/posix/src/signal_2.c index b1bf93cc79..75f13d8f92 100644 --- a/cpukit/posix/src/signal_2.c +++ b/cpukit/posix/src/signal_2.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief POSIX Function Installs signal Handler + * @ingroup POSIX + */ + /* * signal(2) - Install signal handler * diff --git a/cpukit/posix/src/sigprocmask.c b/cpukit/posix/src/sigprocmask.c index 26435f7c03..464343bab0 100644 --- a/cpukit/posix/src/sigprocmask.c +++ b/cpukit/posix/src/sigprocmask.c @@ -1,8 +1,11 @@ -/* - * 3.3.5 Examine and Change Blocked Signals, P1003.1b-1993, p. 73 - * - * NOTE: P1003.1c/D10, p. 37 adds pthread_sigmask(). +/** + * @file * + * @brief Examine and Change Blocked Signals + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -18,6 +21,11 @@ #include <pthread.h> #include <signal.h> +/** + * 3.3.5 Examine and Change Blocked Signals, P1003.1b-1993, p. 73 + * + * NOTE: P1003.1c/D10, p. 37 adds pthread_sigmask(). + */ int sigprocmask( int how, const sigset_t *set, diff --git a/cpukit/posix/src/sigqueue.c b/cpukit/posix/src/sigqueue.c index b1f6cee67e..8b65aba0cb 100644 --- a/cpukit/posix/src/sigqueue.c +++ b/cpukit/posix/src/sigqueue.c @@ -1,6 +1,11 @@ -/* - * 3.3.9 Queue a Signal to a Process, P1003.1b-1993, p. 78 +/** + * @file * + * @brief Queue a Signal to a Process + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/sigsuspend.c b/cpukit/posix/src/sigsuspend.c index f84d11f119..b1f1c4cc77 100644 --- a/cpukit/posix/src/sigsuspend.c +++ b/cpukit/posix/src/sigsuspend.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Replacing signal mask with *sigmask and suspending calling process + * @ingroup POSIX + */ + /* * 3.3.7 Wait for a Signal, P1003.1b-1993, p. 75 * diff --git a/cpukit/posix/src/sigtimedwait.c b/cpukit/posix/src/sigtimedwait.c index 1f23356056..b350a2cc33 100644 --- a/cpukit/posix/src/sigtimedwait.c +++ b/cpukit/posix/src/sigtimedwait.c @@ -1,6 +1,11 @@ -/* - * 3.3.8 Synchronously Accept a Signal, P1003.1b-1993, p. 76 +/** + * @file * + * @brief Wait for Queued Signals + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -58,6 +63,9 @@ found_it: return signo; } +/** + * 3.3.8 Synchronously Accept a Signal, P1003.1b-1993, p. 76 + */ int sigtimedwait( const sigset_t *set, siginfo_t *info, diff --git a/cpukit/posix/src/sigwait.c b/cpukit/posix/src/sigwait.c index cfb733034b..24afa80602 100644 --- a/cpukit/posix/src/sigwait.c +++ b/cpukit/posix/src/sigwait.c @@ -1,8 +1,11 @@ -/* - * 3.3.8 Synchronously Accept a Signal, P1003.1b-1993, p. 76 - * - * NOTE: P1003.1c/D10, p. 39 adds sigwait(). +/** + * @file * + * @brief Synchronously Accept a Signal + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/sigwaitinfo.c b/cpukit/posix/src/sigwaitinfo.c index 0b2045bcad..4538f5df07 100644 --- a/cpukit/posix/src/sigwaitinfo.c +++ b/cpukit/posix/src/sigwaitinfo.c @@ -1,3 +1,9 @@ +/** + * @file + * + * @brief Suspends Execution of Calling Thread until Signals in set Deleivered + */ + /* * 3.3.8 Synchronously Accept a Signal, P1003.1b-1993, p. 76 * diff --git a/cpukit/posix/src/testcancel.c b/cpukit/posix/src/testcancel.c index 400ab7efe5..6228af6165 100644 --- a/cpukit/posix/src/testcancel.c +++ b/cpukit/posix/src/testcancel.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Setting test on Cancelability State + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/timerdelete.c b/cpukit/posix/src/timerdelete.c index 89cfe2f056..473c0df3fe 100644 --- a/cpukit/posix/src/timerdelete.c +++ b/cpukit/posix/src/timerdelete.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Deletes a POSIX Interval Timer + * @ingroup POSIX + */ + /* * 14.2.3 Delete a Per_process Timer, P1003.1b-1993, p. 266 * diff --git a/cpukit/posix/src/timergetoverrun.c b/cpukit/posix/src/timergetoverrun.c index 9403d02f5c..23a4e6f3fe 100644 --- a/cpukit/posix/src/timergetoverrun.c +++ b/cpukit/posix/src/timergetoverrun.c @@ -1,6 +1,11 @@ -/* - * 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267 +/** + * @file * + * @brief Get Overrun Count for a POSIX Per-Process Timer + * @ingroup POSIX_PRIV_TIMERS + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -21,13 +26,6 @@ #include <rtems/score/thread.h> #include <rtems/posix/timer.h> -/* - * timer_getoverrun - * - * The expiration of a timer must increase by one a counter. - * After the signal handler associated to the timer finishes - * its execution, _POSIX_Timer_TSR will have to set this counter to 0. - */ int timer_getoverrun( timer_t timerid ) diff --git a/cpukit/posix/src/timergettime.c b/cpukit/posix/src/timergettime.c index 3aa63e32f7..823989a4e4 100644 --- a/cpukit/posix/src/timergettime.c +++ b/cpukit/posix/src/timergettime.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Fetches State of POSIX Per-Process Timers + * @ingroup POSIX + */ + /* * 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267 * diff --git a/cpukit/posix/src/timerinserthelper.c b/cpukit/posix/src/timerinserthelper.c index 9e2aa6a437..a1726770d9 100644 --- a/cpukit/posix/src/timerinserthelper.c +++ b/cpukit/posix/src/timerinserthelper.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Helper Routine for POSIX TIMERS + * @ingroup POSIX + */ + /* * Helper routine for POSIX timers * diff --git a/cpukit/posix/src/timersettime.c b/cpukit/posix/src/timersettime.c index b0c3061023..00cce57b59 100644 --- a/cpukit/posix/src/timersettime.c +++ b/cpukit/posix/src/timersettime.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Function Arms or Disarms the Timer Identified by timerid + * @ingroup POSIX + */ + /* * 14.2.4 Per-Process Timers, P1003.1b-1993, p. 267 * diff --git a/cpukit/posix/src/ualarm.c b/cpukit/posix/src/ualarm.c index 2a2f975d67..34ab0a41cc 100644 --- a/cpukit/posix/src/ualarm.c +++ b/cpukit/posix/src/ualarm.c @@ -1,6 +1,11 @@ -/* - * 3.4.1 Schedule Alarm, P1003.1b-1993, p. 79 +/** + * @file * + * @brief Schedule Alarm + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/vfork.c b/cpukit/posix/src/vfork.c index 64838c8d87..3bb0f31b83 100644 --- a/cpukit/posix/src/vfork.c +++ b/cpukit/posix/src/vfork.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Creates Child process Of The Calling process + * @ingroup POSIX + */ + /* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). diff --git a/cpukit/posix/src/wait.c b/cpukit/posix/src/wait.c index 1984c47741..8e48af71d6 100644 --- a/cpukit/posix/src/wait.c +++ b/cpukit/posix/src/wait.c @@ -1,6 +1,11 @@ -/* - * waitpid() - POSIX 1003.1b 3.2.1 +/** + * @file * + * @brief Wait for Process to Change State + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/posix/src/waitpid.c b/cpukit/posix/src/waitpid.c index 0ae199156f..03e4f7d731 100644 --- a/cpukit/posix/src/waitpid.c +++ b/cpukit/posix/src/waitpid.c @@ -1,6 +1,11 @@ -/* - * waitpid() - POSIX 1003.1 3.2.1 +/** + * @file * + * @brief Wait for Process to Change State + * @ingroup POSIX + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * |