From 205dbb9df9c8d39c955d6b807a59e258c319ad3d Mon Sep 17 00:00:00 2001 From: Alex Ivanov Date: Mon, 3 Dec 2012 13:18:33 -0600 Subject: cpukit: Clean up Doxygen #3 (GCI 2012) --- cpukit/rtems/include/rtems/rtems/clock.h | 5 ++-- cpukit/rtems/include/rtems/rtems/dpmem.h | 19 +++++++++++-- cpukit/rtems/include/rtems/rtems/eventmp.h | 8 +++--- cpukit/rtems/include/rtems/rtems/message.h | 4 ++- cpukit/rtems/include/rtems/rtems/mp.h | 4 +-- cpukit/rtems/include/rtems/rtems/object.h | 2 +- cpukit/rtems/include/rtems/rtems/part.h | 7 ++++- cpukit/rtems/include/rtems/rtems/region.h | 7 ++++- cpukit/rtems/include/rtems/rtems/regionmp.h | 12 ++++---- cpukit/rtems/include/rtems/rtems/signal.h | 8 +++++- cpukit/rtems/include/rtems/rtems/tasks.h | 19 +++++++++++-- cpukit/rtems/include/rtems/rtems/timer.h | 7 ++++- cpukit/rtems/src/barriertranslatereturncode.c | 20 +++++-------- cpukit/rtems/src/clockset.c | 22 +++++--------- cpukit/rtems/src/clocktick.c | 22 +++++--------- cpukit/rtems/src/clocktodtoseconds.c | 23 +++++---------- cpukit/rtems/src/dpmemexternal2internal.c | 27 +++++------------- cpukit/rtems/src/dpmemident.c | 25 +++++----------- cpukit/rtems/src/eventmp.c | 30 +++++--------------- cpukit/rtems/src/mp.c | 20 +++++-------- cpukit/rtems/src/msgqallocate.c | 24 +++++----------- cpukit/rtems/src/partgetbuffer.c | 25 +++++----------- cpukit/rtems/src/regionmp.c | 41 +++++---------------------- cpukit/rtems/src/regionreturnsegment.c | 24 +++++----------- cpukit/rtems/src/rtemsobjectgetclassicname.c | 25 +++++----------- cpukit/rtems/src/rtemsobjectidapimaximum.c | 9 ++++-- cpukit/rtems/src/signalcatch.c | 25 +++++----------- cpukit/rtems/src/taskdata.c | 8 +++++- cpukit/rtems/src/taskgetnote.c | 27 +++++------------- cpukit/rtems/src/taskrestart.c | 27 +++++------------- cpukit/rtems/src/taskself.c | 9 ++++-- cpukit/rtems/src/timercreate.c | 25 +++++----------- 32 files changed, 216 insertions(+), 344 deletions(-) diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h index 7c12cce708..c841d1a4f8 100644 --- a/cpukit/rtems/include/rtems/rtems/clock.h +++ b/cpukit/rtems/include/rtems/rtems/clock.h @@ -191,7 +191,8 @@ rtems_status_code rtems_clock_set( * @return This directive always returns RTEMS_SUCCESSFUL. * * @note This method is typically called from an ISR and is the basis - * for all timeouts and delays. + * for all timeouts and delays. This routine only works for leap-years + * through 2099. */ rtems_status_code rtems_clock_tick( void ); @@ -256,7 +257,7 @@ bool _TOD_Validate( ); /** - * @brief _TOD_To_seconds + * @brief TOD to Seconds * * This function returns the number seconds between the epoch and @a the_tod. * diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h index 7ccb2255f6..4869dee6c0 100644 --- a/cpukit/rtems/include/rtems/rtems/dpmem.h +++ b/cpukit/rtems/include/rtems/rtems/dpmem.h @@ -101,11 +101,16 @@ rtems_status_code rtems_port_create( ); /** - * @brief rtems_port_ident + * @brief RTEMS Port Name to Id * * This routine implements the rtems_port_ident directive. This directive * returns the port ID associated with name. If more than one port is * named name, then the port to which the ID belongs is arbitrary. + * + * @param[in] name is the user defined port name + * @param[out] id is the pointer to port id + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_port_ident( rtems_name name, @@ -123,11 +128,19 @@ rtems_status_code rtems_port_delete( ); /** - * @brief rtems_port_external_to_internal + * @brief RTEMS Port External to Internal * * This routine implements the rtems_port_external_to_internal directive. * It returns the internal port address which maps to the provided - * external port address for the specified port ID. + * external port address for the specified port ID.If the given external + * address is an invalid dual-ported address, then the internal address is + * set to the given external address. + * + * @param[in] id is the id of dp memory object + * @param[in] external is the external address + * @param[out] internal is the pointer of internal address to set + * + * @return RTEMS_SUCCESSFUL */ rtems_status_code rtems_port_external_to_internal( rtems_id id, diff --git a/cpukit/rtems/include/rtems/rtems/eventmp.h b/cpukit/rtems/include/rtems/rtems/eventmp.h index aa09e348cc..a54f79cffe 100644 --- a/cpukit/rtems/include/rtems/rtems/eventmp.h +++ b/cpukit/rtems/include/rtems/rtems/eventmp.h @@ -65,7 +65,7 @@ typedef struct { */ /** - * @brief Event_MP_Send_request_packet + * @brief Event MP Send Packet Request * * This routine performs a remote procedure call so that a * directive operation can be initiated on another node. @@ -77,7 +77,7 @@ rtems_status_code _Event_MP_Send_request_packet ( ); /** - * @brief Event_MP_Send_response_packet + * @brief Event MP Send Packet Response * * This routine performs a remote procedure call so that a * directive can be performed on another node. @@ -88,7 +88,7 @@ void _Event_MP_Send_response_packet ( ); /** - * @brief Event_MP_Process_packet + * @brief Event MP Packet Process * * This routine performs the actions specific to this package for * the request from another node. @@ -120,7 +120,7 @@ void _Event_MP_Process_packet ( */ /** - * @brief Event_MP_Get_packet + * @brief Event MP Get Packet * * This function is used to obtain a event mp packet. */ diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index 69eab62d7c..fa80862fb3 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -286,10 +286,12 @@ rtems_status_code _Message_queue_Submit( ); /** - * @brief Message_queue_Allocate + * @brief Message Queue Allocate * * This function allocates a message queue control block from * the inactive chain of free message queue control blocks. + * + * @return the_message_queue filled in if successful, NULL otherwise */ Message_queue_Control *_Message_queue_Allocate (void); diff --git a/cpukit/rtems/include/rtems/rtems/mp.h b/cpukit/rtems/include/rtems/rtems/mp.h index c04b0b1c64..f7b5f20c62 100644 --- a/cpukit/rtems/include/rtems/rtems/mp.h +++ b/cpukit/rtems/include/rtems/rtems/mp.h @@ -30,14 +30,14 @@ extern "C" { #endif /** - * @brief Multiprocessing_Manager_initialization + * @brief Multiprocessing Manager Initialization * * This routine performs the initialization necessary for this manager. */ void _Multiprocessing_Manager_initialization ( void ); /** - * @brief rtems_multiprocessing_announce + * @brief RTEMS Multiprocessing Announce * * This routine implements the MULTIPROCESSING_ANNOUNCE directive. * It is invoked by the MPCI layer to indicate that an MPCI packet diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h index 94a52978a8..ced287f8b7 100644 --- a/cpukit/rtems/include/rtems/rtems/object.h +++ b/cpukit/rtems/include/rtems/rtems/object.h @@ -89,7 +89,7 @@ typedef struct { _Objects_Build_name( _C1, _C2, _C3, _C4 ) /** - * @brief Obtain name of object + * @brief Obtain Name of Object * * This directive returns the name associated with the specified * object ID. diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index 8415f9ca5b..b6b5b3a3dc 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -145,11 +145,16 @@ rtems_status_code rtems_partition_delete( ); /** - * @brief rtems_partition_get_buffer + * @brief RTEMS Get Partition Buffer * * This routine implements the rtems_partition_get_buffer directive. It * attempts to allocate a buffer from the partition associated with ID. * If a buffer is allocated, its address is returned in buffer. + * + * @param[in] id is the partition id + * @param[out] buffer is the pointer to buffer address + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_partition_get_buffer( rtems_id id, diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index a35acf97e2..61162cbb99 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -207,7 +207,7 @@ rtems_status_code rtems_region_get_segment_size( ); /** - * @brief rtems_region_return_segment + * @brief RTEMS Return Region Segment * * This routine implements the rtems_region_return_segment directive. It * frees the segment to the region associated with ID. The segment must @@ -216,6 +216,11 @@ rtems_status_code rtems_region_get_segment_size( * rtems_region_get_segment of the first blocked task, then that task and as * many subsequent tasks as possible will be unblocked with their requests * satisfied. + * + * @param[in] id is the region id + * @param[in] segment is the pointer to segment address + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_region_return_segment( rtems_id id, diff --git a/cpukit/rtems/include/rtems/rtems/regionmp.h b/cpukit/rtems/include/rtems/rtems/regionmp.h index 7465bbfd4f..f4adc2bda1 100644 --- a/cpukit/rtems/include/rtems/rtems/regionmp.h +++ b/cpukit/rtems/include/rtems/rtems/regionmp.h @@ -65,7 +65,7 @@ typedef struct { } Region_MP_Packet; /** - * @brief _Region_MP_Send_process_packet + * @brief Region MP Send Process Packet * * This routine performs a remote procedure call so that a * process operation can be performed on another node. @@ -78,7 +78,7 @@ void _Region_MP_Send_process_packet ( ); /** - * @brief _Region_MP_Send_request_packet + * @brief Region MP Send Request Packet * * This routine performs a remote procedure call so that a * directive operation can be initiated on another node. @@ -93,7 +93,7 @@ rtems_status_code _Region_MP_Send_request_packet ( ); /** - * @brief _Region_MP_Send_response_packet + * @brief Region MP Send Response Packet * * This routine performs a remote procedure call so that a * directive can be performed on another node. @@ -105,7 +105,7 @@ void _Region_MP_Send_response_packet ( ); /** - * @brief _Region_MP_Process_packet + * @brief Region MP Process Packet * * This routine performs the actions specific to this package for * the request from another node. @@ -126,7 +126,7 @@ void _Region_MP_Process_packet ( */ /** - * @brief _Region_MP_Send_extract_proxy + * @brief Region MP Send Extract Proxy * * This routine is invoked when a task is deleted and it * has a proxy which must be removed from a thread queue and @@ -137,7 +137,7 @@ void _Region_MP_Send_extract_proxy ( ); /** - * @brief _Region_MP_Get_packet + * @brief RegionMP Get Packet * * This function is used to obtain a region mp packet. */ diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h index 046842f97f..54359ccfaa 100644 --- a/cpukit/rtems/include/rtems/rtems/signal.h +++ b/cpukit/rtems/include/rtems/rtems/signal.h @@ -48,12 +48,18 @@ extern "C" { void _Signal_Manager_initialization( void ); /** - * @brief rtems_signal_catch + * @brief RTEMS Catch Signal * * This routine implements the rtems_signal_catch directive. This directive * is used to establish asr_handler as the Asynchronous Signal Routine * (RTEMS_ASR) for the calling task. The asr_handler will execute with a * mode of mode_set. + * + * @param[in] asr_handler is the address of asynchronous signal routine (asr) + * ( NULL indicates asr is invalid ) + * @param[in] mode_set is the mode value for asr + * + * @return RTEMS_SUCCESSFUL */ rtems_status_code rtems_signal_catch( rtems_asr_entry asr_handler, diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h index b6b1c1c5b2..03795d5e37 100644 --- a/cpukit/rtems/include/rtems/rtems/tasks.h +++ b/cpukit/rtems/include/rtems/rtems/tasks.h @@ -44,6 +44,8 @@ #include /** + * @brief Instantiate RTEMS Classic API Tasks Data + * * This constant is defined to extern most of the time when using * this header file. However by defining it to nothing, the data * declared in this header file can be instantiated. This is done @@ -303,11 +305,17 @@ rtems_status_code rtems_task_delete( ); /** - * @brief rtems_task_get_note + * @brief RTEMS Get Task Node * * This routine implements the rtems_task_get_note directive. The * value of the indicated notepad for the task associated with ID * is returned in note. + * + * @param[in] id is the thread id + * @param[in] notepad is the notepad number + * @param[out] note is the pointer to note + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_task_get_note( rtems_id id, @@ -343,11 +351,16 @@ rtems_status_code rtems_task_mode( ); /** - * @brief rtems_task_restart + * @brief RTEMS Task Restart * * This routine implements the rtems_task_restart directive. The * task associated with ID is restarted at its initial entry * point with the new argument. + * + * @param[in] id is the thread id + * @param[in] arg is the thread argument + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_task_restart( rtems_id id, @@ -480,7 +493,7 @@ rtems_status_code rtems_task_variable_delete( ); /** - * @brief rtems_task_self + * @brief RTEMS Get Self Task Id * * This directive returns the ID of the currently executing task. */ diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h index 982f5dabd0..b75a474358 100644 --- a/cpukit/rtems/include/rtems/rtems/timer.h +++ b/cpukit/rtems/include/rtems/rtems/timer.h @@ -227,11 +227,16 @@ RTEMS_TIMER_EXTERN Objects_Information _Timer_Information; void _Timer_Manager_initialization(void); /** - * @brief rtems_timer_create + * @brief RTEMS Create Timer * * This routine implements the rtems_timer_create directive. The * timer will have the name name. It returns the id of the * created timer in ID. + * + * @param[in] name is the timer name + * @param[out] id is the pointer to timer id + * + * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_timer_create( rtems_name name, diff --git a/cpukit/rtems/src/barriertranslatereturncode.c b/cpukit/rtems/src/barriertranslatereturncode.c index 423de90868..424be88892 100644 --- a/cpukit/rtems/src/barriertranslatereturncode.c +++ b/cpukit/rtems/src/barriertranslatereturncode.c @@ -1,6 +1,11 @@ -/* - * Barrier Manager -- Translate SuperCore Status +/** + * @file * + * @brief Translate SuperCore Barrier Status Code to RTEMS Status Code + * @ingroup ClassicBarrier + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -18,17 +23,6 @@ #include #include -/* - * _Barrier_Translate_core_barrier_return_code - * - * Input parameters: - * the_barrier_status - barrier status code to translate - * - * Output parameters: - * rtems status code - translated RTEMS status code - * - */ - rtems_status_code _Barrier_Translate_core_barrier_return_code_[] = { RTEMS_SUCCESSFUL, /* CORE_BARRIER_STATUS_SUCCESSFUL */ RTEMS_SUCCESSFUL, /* CORE_BARRIER_STATUS_AUTOMATICALLY_RELEASED */ diff --git a/cpukit/rtems/src/clockset.c b/cpukit/rtems/src/clockset.c index 55ec3935ef..74a50f7233 100644 --- a/cpukit/rtems/src/clockset.c +++ b/cpukit/rtems/src/clockset.c @@ -1,6 +1,11 @@ -/* - * Clock Manager +/** + * @file * + * @brief Set the Current TOD + * @ingroup ClassicClock + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -22,19 +27,6 @@ #include #include -/* - * rtems_clock_set - * - * This directive sets the date and time for this node. - * - * Input parameters: - * tod - pointer to the time and date structure - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_clock_set( const rtems_time_of_day *tod ) diff --git a/cpukit/rtems/src/clocktick.c b/cpukit/rtems/src/clocktick.c index a00d021a2b..1bd91ac336 100644 --- a/cpukit/rtems/src/clocktick.c +++ b/cpukit/rtems/src/clocktick.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Announce a Clock Tick + * @ingroup ClassicClock + */ + /* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). @@ -19,21 +26,6 @@ #include #include -/* - * rtems_clock_tick - * - * This directive notifies the executve that a tick has occurred. - * When the tick occurs the time manager updates and maintains - * the calendar time, timeslicing, and any timeout delays. - * - * Input parameters: NONE - * - * Output parameters: - * RTEMS_SUCCESSFUL - always succeeds - * - * NOTE: This routine only works for leap-years through 2099. - */ - rtems_status_code rtems_clock_tick( void ) { _TOD_Tickle_ticks(); diff --git a/cpukit/rtems/src/clocktodtoseconds.c b/cpukit/rtems/src/clocktodtoseconds.c index a27455b056..9f80b5390b 100644 --- a/cpukit/rtems/src/clocktodtoseconds.c +++ b/cpukit/rtems/src/clocktodtoseconds.c @@ -1,6 +1,11 @@ -/* - * Time of Day (TOD) Handler - Classic TOD to Seconds +/** + * @file * + * @brief TOD to Seconds + * @ingroup ClassicClock + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -37,20 +42,6 @@ const uint16_t _TOD_Days_to_date[2][13] = { const uint16_t _TOD_Days_since_last_leap_year[4] = { 0, 366, 731, 1096 }; - -/* - * _TOD_To_seconds - * - * This routine returns the seconds from the epoch until the - * current date and time. - * - * Input parameters: - * the_tod - pointer to the time and date structure - * - * Output parameters: - * returns - seconds since epoch until the_tod - */ - uint32_t _TOD_To_seconds( const rtems_time_of_day *the_tod ) diff --git a/cpukit/rtems/src/dpmemexternal2internal.c b/cpukit/rtems/src/dpmemexternal2internal.c index c6f1c11d7b..f5248fe946 100644 --- a/cpukit/rtems/src/dpmemexternal2internal.c +++ b/cpukit/rtems/src/dpmemexternal2internal.c @@ -1,6 +1,11 @@ -/* - * Dual Port Memory Manager +/** + * @file * + * @brief RTEMS Port External to Internal + * @ingroup ClassicDPMEM + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -22,24 +27,6 @@ #include #include -/* - * rtems_port_external_to_internal - * - * This directive converts an external dual-ported memory address to an - * internal dual-ported memory address. If the given external address - * is an invalid dual-ported address, then the internal address is set - * to the given external address. - * - * Input parameters: - * id - id of dp memory object - * external - external address - * internal - pointer of internal address to set - * - * Output parameters: - * internal - internal address - * RTEMS_SUCCESSFUL - always succeeds - */ - rtems_status_code rtems_port_external_to_internal( rtems_id id, void *external, diff --git a/cpukit/rtems/src/dpmemident.c b/cpukit/rtems/src/dpmemident.c index e8e2a359ac..8004c19ca9 100644 --- a/cpukit/rtems/src/dpmemident.c +++ b/cpukit/rtems/src/dpmemident.c @@ -1,6 +1,11 @@ -/* - * Dual Port Memory Manager +/** + * @file * + * @brief RTEMS Port Name to Id + * @ingroup ClassicDPMEM + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -22,22 +27,6 @@ #include #include -/* - * rtems_port_ident - * - * This directive returns the system ID associated with - * the port name. - * - * Input parameters: - * name - user defined port name - * id - pointer to port id - * - * Output parameters: - * *id - port id - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_port_ident( rtems_name name, rtems_id *id diff --git a/cpukit/rtems/src/eventmp.c b/cpukit/rtems/src/eventmp.c index 0d640ce7fb..d4c890b434 100644 --- a/cpukit/rtems/src/eventmp.c +++ b/cpukit/rtems/src/eventmp.c @@ -1,6 +1,11 @@ -/* - * Multiprocessing Support for the Event Manager +/** + * @file * + * @brief Event MP Support + * @ingroup ClassicEventMP + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -37,11 +42,6 @@ RTEMS_STATIC_ASSERT( * */ -/* - * _Event_MP_Send_request_packet - * - */ - rtems_status_code _Event_MP_Send_request_packet ( Event_MP_Remote_operations operation, Objects_Id event_id, @@ -82,11 +82,6 @@ rtems_status_code _Event_MP_Send_request_packet ( return RTEMS_SUCCESSFUL; } -/* - * _Event_MP_Send_response_packet - * - */ - void _Event_MP_Send_response_packet ( Event_MP_Remote_operations operation, Thread_Control *the_thread @@ -119,12 +114,6 @@ void _Event_MP_Send_response_packet ( } } -/* - * - * _Event_MP_Process_packet - * - */ - void _Event_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ) @@ -176,11 +165,6 @@ void _Event_MP_Process_packet ( * */ -/* - * _Event_MP_Get_packet - * - */ - Event_MP_Packet *_Event_MP_Get_packet ( void ) { return ( (Event_MP_Packet *) _MPCI_Get_packet() ); diff --git a/cpukit/rtems/src/mp.c b/cpukit/rtems/src/mp.c index dc352ca8e7..2d2996c3c0 100644 --- a/cpukit/rtems/src/mp.c +++ b/cpukit/rtems/src/mp.c @@ -1,7 +1,11 @@ -/* - * Multiprocessing Manager - * +/** + * @file * + * @brief MP Support + * @ingroup ClassicMP + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -19,20 +23,10 @@ #include #include -/* - * _Multiprocessing_Manager_initialization - * - */ - void _Multiprocessing_Manager_initialization ( void ) { } -/* - * rtems_multiprocessing_announce - * - */ - void rtems_multiprocessing_announce ( void ) { _MPCI_Announce(); diff --git a/cpukit/rtems/src/msgqallocate.c b/cpukit/rtems/src/msgqallocate.c index 39c60c9e81..7251289314 100644 --- a/cpukit/rtems/src/msgqallocate.c +++ b/cpukit/rtems/src/msgqallocate.c @@ -1,7 +1,11 @@ -/* - * Message Queue Manager - * +/** + * @file * + * @brief Message Queue Allocate + * @ingroup ClassicMessageQueue + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -32,20 +36,6 @@ #include #include -/* - * _Message_queue_Allocate - * - * Allocate a message queue and the space for its messages - * - * Input parameters: - * the_message_queue - the message queue to allocate message buffers - * count - maximum message and reserved buffer count - * max_message_size - maximum size of each message - * - * Output parameters: - * the_message_queue - set if successful, NULL otherwise - */ - Message_queue_Control *_Message_queue_Allocate(void) { return (Message_queue_Control *) diff --git a/cpukit/rtems/src/partgetbuffer.c b/cpukit/rtems/src/partgetbuffer.c index 2a32c4e57f..f281fe4e65 100644 --- a/cpukit/rtems/src/partgetbuffer.c +++ b/cpukit/rtems/src/partgetbuffer.c @@ -1,7 +1,11 @@ -/* - * Partition Manager - * +/** + * @file * + * @brief RTEMS Get Partition Buffer + * @ingroup ClassicPart + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -23,21 +27,6 @@ #include #include -/* - * rtems_partition_get_buffer - * - * This directive will obtain a buffer from a buffer partition. - * - * Input parameters: - * id - partition id - * buffer - pointer to buffer address - * - * Output parameters: - * buffer - pointer to buffer address filled in - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_partition_get_buffer( rtems_id id, void **buffer diff --git a/cpukit/rtems/src/regionmp.c b/cpukit/rtems/src/regionmp.c index 7d8efcb07d..9d2e5fb3a6 100644 --- a/cpukit/rtems/src/regionmp.c +++ b/cpukit/rtems/src/regionmp.c @@ -1,7 +1,11 @@ -/* - * Multiprocessing Support for the Region Manager - * +/** + * @file * + * @brief Region MP Support + * @ingroup ClassicRegionMP + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -29,11 +33,6 @@ RTEMS_STATIC_ASSERT( Region_MP_Packet ); -/* - * _Region_MP_Send_process_packet - * - */ - void _Region_MP_Send_process_packet ( Region_MP_Remote_operations operation, Objects_Id region_id, @@ -75,11 +74,6 @@ void _Region_MP_Send_process_packet ( } } -/* - * _Region_MP_Send_request_packet - * - */ - rtems_status_code _Region_MP_Send_request_packet ( Region_MP_Remote_operations operation, Objects_Id region_id, @@ -131,11 +125,6 @@ rtems_status_code _Region_MP_Send_request_packet ( return RTEMS_INTERNAL_ERROR; } -/* - * _Region_MP_Send_response_packet - * - */ - void _Region_MP_Send_response_packet ( Region_MP_Remote_operations operation, Objects_Id region_id, @@ -174,12 +163,6 @@ void _Region_MP_Send_response_packet ( } } -/* - * - * _Region_MP_Process_packet - * - */ - void _Region_MP_Process_packet ( rtems_packet_prefix *the_packet_prefix ) @@ -279,11 +262,6 @@ void _Region_MP_Process_packet ( * */ -/* - * _Region_MP_Send_extract_proxy - * - */ - void _Region_MP_Send_extract_proxy ( void *argument ) @@ -298,11 +276,6 @@ void _Region_MP_Send_extract_proxy ( ); } -/* - * _Region_MP_Get_packet - * - */ - Region_MP_Packet *_Region_MP_Get_packet ( void ) { return ( (Region_MP_Packet *) _MPCI_Get_packet() ); diff --git a/cpukit/rtems/src/regionreturnsegment.c b/cpukit/rtems/src/regionreturnsegment.c index 37e4e6f85c..56783a7411 100644 --- a/cpukit/rtems/src/regionreturnsegment.c +++ b/cpukit/rtems/src/regionreturnsegment.c @@ -1,7 +1,11 @@ -/* - * Region Manager - * +/** + * @file * + * @brief RTEMS Return Region Segment + * @ingroup ClassicRegion + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -32,20 +36,6 @@ #include #include -/* - * rtems_region_return_segment - * - * This directive will return a segment to its region. - * - * Input parameters: - * id - region id - * segment - pointer to segment address - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_region_return_segment( rtems_id id, void *segment diff --git a/cpukit/rtems/src/rtemsobjectgetclassicname.c b/cpukit/rtems/src/rtemsobjectgetclassicname.c index e34261cc95..559b2e7694 100644 --- a/cpukit/rtems/src/rtemsobjectgetclassicname.c +++ b/cpukit/rtems/src/rtemsobjectgetclassicname.c @@ -1,7 +1,11 @@ -/* - * RTEMS ID To Name Lookup - * +/** + * @file * + * @brief Obtain Name of Object + * @ingroup ClassicClassInfo + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * @@ -20,21 +24,6 @@ #include #include -/* - * rtems_object_get_classic_name - * - * This directive returns the name associated with the specified - * object ID. - * - * Input parameters: - * id - message queue id - * - * Output parameters: - * *name - user defined object name - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_object_get_classic_name( rtems_id id, rtems_name *name diff --git a/cpukit/rtems/src/rtemsobjectidapimaximum.c b/cpukit/rtems/src/rtemsobjectidapimaximum.c index 69cb9d899c..1073cb0c13 100644 --- a/cpukit/rtems/src/rtemsobjectidapimaximum.c +++ b/cpukit/rtems/src/rtemsobjectidapimaximum.c @@ -1,6 +1,11 @@ -/* - * RTEMS Object Helper -- Get Greatest Valid API Number +/** + * @file * + * @brief Get Highest Valid API Index + * @ingroup ClassicClassInfo + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/signalcatch.c b/cpukit/rtems/src/signalcatch.c index 4170b614e9..31bb69fe49 100644 --- a/cpukit/rtems/src/signalcatch.c +++ b/cpukit/rtems/src/signalcatch.c @@ -1,7 +1,11 @@ -/* - * Signal Manager - * +/** + * @file * + * @brief RTEMS Catch Signal + * @ingroup ClassicSignal + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * @@ -23,21 +27,6 @@ #include #include -/* - * rtems_signal_catch - * - * This directive allows a thread to specify what action to take when - * catching signals. - * - * Input parameters: - * handler - address of asynchronous signal routine (asr) - * ( NULL indicates asr is invalid ) - * mode_set - mode value for asr - * - * Output parameters: - * RTEMS_SUCCESSFUL - always succeeds - */ - rtems_status_code rtems_signal_catch( rtems_asr_entry asr_handler, rtems_mode mode_set diff --git a/cpukit/rtems/src/taskdata.c b/cpukit/rtems/src/taskdata.c index 46e44747be..2e9666cbb8 100644 --- a/cpukit/rtems/src/taskdata.c +++ b/cpukit/rtems/src/taskdata.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Instantiate RTEMS Classic API Tasks Data + * @ingroup ClassicTasks + */ + /* * RTEMS Task Manager -- Instantiate Data * @@ -13,7 +20,6 @@ #include "config.h" #endif -/* instantiate RTEMS Classic API tasks data */ #define RTEMS_TASKS_EXTERN #include diff --git a/cpukit/rtems/src/taskgetnote.c b/cpukit/rtems/src/taskgetnote.c index 3696f9117d..65b2aa21f9 100644 --- a/cpukit/rtems/src/taskgetnote.c +++ b/cpukit/rtems/src/taskgetnote.c @@ -1,7 +1,11 @@ -/* - * RTEMS Task Manager - * +/** + * @file * + * @brief RTEMS Get Task Node + * @ingroup ClassicRTEMS + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -30,23 +34,6 @@ #include #include -/* - * rtems_task_get_note - * - * This directive obtains the note from the specified notepad - * of the specified thread. - * - * Input parameters: - * id - thread id - * notepad - notepad number - * note - pointer to note - * - * Output parameters: - * note - filled in if successful - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_task_get_note( rtems_id id, uint32_t notepad, diff --git a/cpukit/rtems/src/taskrestart.c b/cpukit/rtems/src/taskrestart.c index 3a560a9eb5..75fcbb342e 100644 --- a/cpukit/rtems/src/taskrestart.c +++ b/cpukit/rtems/src/taskrestart.c @@ -1,7 +1,11 @@ -/* - * RTEMS Task Manager - * +/** + * @file * + * @brief RTEMS Task Restart + * @ingroup ClassicTasks + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * @@ -29,23 +33,6 @@ #include #include -/* - * rtems_task_restart - * - * This directive readies the specified thread. It restores - * the thread environment to the original values established - * at thread creation and start time. A thread can be restarted - * from any state except the dormant state. - * - * Input parameters: - * id - thread id - * argument - thread argument - * - * Output parameters: - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_task_restart( rtems_id id, uint32_t argument diff --git a/cpukit/rtems/src/taskself.c b/cpukit/rtems/src/taskself.c index 14fc4ca66b..c13e14c4f9 100644 --- a/cpukit/rtems/src/taskself.c +++ b/cpukit/rtems/src/taskself.c @@ -1,6 +1,11 @@ -/* - * RTEMS Task Manager - Get ID of Self +/** + * @file * + * @brief RTEMS Get Self Task Id + * @ingroup ClassicTasks + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/timercreate.c b/cpukit/rtems/src/timercreate.c index 8d53fc4ecb..f37b9e18c0 100644 --- a/cpukit/rtems/src/timercreate.c +++ b/cpukit/rtems/src/timercreate.c @@ -1,7 +1,11 @@ -/* - * Timer Manager - rtems_timer_create directive - * +/** + * @file * + * @brief RTEMS Create Timer + * @ingroup ClassicTimer + */ + +/* * COPYRIGHT (c) 1989-2002. * On-Line Applications Research Corporation (OAR). * @@ -23,21 +27,6 @@ #include #include -/* - * rtems_timer_create - * - * This directive creates a timer and performs some initialization. - * - * Input parameters: - * name - timer name - * id - pointer to timer id - * - * Output parameters: - * id - timer id - * RTEMS_SUCCESSFUL - if successful - * error code - if unsuccessful - */ - rtems_status_code rtems_timer_create( rtems_name name, rtems_id *id -- cgit v1.2.3