From 4efe1955132708b2e88fd046b04eee00fdad0c38 Mon Sep 17 00:00:00 2001 From: Mathew Kallada Date: Wed, 5 Dec 2012 19:46:05 -0500 Subject: rtems misc: Clean up Doxygen GCI Task #5 http://www.google-melange.com/gci/task/view/google/gci2012/8015207 --- cpukit/rtems/include/rtems/rtems/clock.h | 6 ++++++ cpukit/rtems/include/rtems/rtems/dpmem.h | 1 + cpukit/rtems/include/rtems/rtems/message.h | 22 +++++++++++++--------- cpukit/rtems/include/rtems/rtems/object.h | 5 +++++ cpukit/rtems/include/rtems/rtems/part.h | 6 ++++-- cpukit/rtems/include/rtems/rtems/partmp.h | 2 ++ cpukit/rtems/include/rtems/rtems/ratemon.h | 18 ++++++++++-------- cpukit/rtems/include/rtems/rtems/region.h | 20 ++++++++++++++------ cpukit/rtems/include/rtems/rtems/sem.h | 17 ++++++++++++----- cpukit/rtems/include/rtems/rtems/tasks.h | 20 ++++++++++++-------- cpukit/rtems/src/clockgettod.c | 9 +++++++-- cpukit/rtems/src/clockgetuptime.c | 9 +++++++-- cpukit/rtems/src/clockgetuptimeseconds.c | 7 +++++++ cpukit/rtems/src/clocksetnsecshandler.c | 9 +++++++-- cpukit/rtems/src/dpmemdata.c | 9 +++++++-- cpukit/rtems/src/msgqflush.c | 10 +++++++--- cpukit/rtems/src/msgqsend.c | 9 +++++++-- cpukit/rtems/src/partdata.c | 9 +++++++-- cpukit/rtems/src/partmp.c | 10 +++++++--- cpukit/rtems/src/ratemonresetall.c | 9 +++++++-- cpukit/rtems/src/region.c | 10 +++++++--- cpukit/rtems/src/regioncreate.c | 10 +++++++--- cpukit/rtems/src/regiondata.c | 9 +++++++-- cpukit/rtems/src/rtemsbuildid.c | 9 +++++++-- cpukit/rtems/src/rtemsobjectapiminimumclass.c | 9 +++++++-- cpukit/rtems/src/rtemsobjectsetname.c | 9 +++++++-- cpukit/rtems/src/semcreate.c | 23 +++++++---------------- cpukit/rtems/src/semdata.c | 9 +++++++-- cpukit/rtems/src/taskinitusers.c | 10 +++++++--- cpukit/rtems/src/taskissuspended.c | 10 +++++++--- 30 files changed, 219 insertions(+), 96 deletions(-) diff --git a/cpukit/rtems/include/rtems/rtems/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h index fc6a584ab9..7eaa2cbf3e 100644 --- a/cpukit/rtems/include/rtems/rtems/clock.h +++ b/cpukit/rtems/include/rtems/rtems/clock.h @@ -95,6 +95,8 @@ rtems_status_code rtems_clock_get( * This routine implements the rtems_clock_get_tod directive. It returns * the current time of day in the format defined by RTEID. * + * Clock Manager - rtems_clock_get_tod + * * @param[in] time_buffer points to the time of day structure * * @return This method returns RTEMS_SUCCESSFUL if there was not an @@ -199,6 +201,8 @@ rtems_status_code rtems_clock_tick( void ); /** * @brief Set the BSP specific Nanoseconds Extension * + * Clock Manager + * * This directive sets the BSP provided nanoseconds since last tick * extension. * @@ -223,6 +227,8 @@ rtems_status_code rtems_clock_set_nanoseconds_extension( * error. Otherwise, a status code is returned indicating the * source of the error. If successful, the uptime will be * filled in. + * + * Clock Manager - get uptime */ rtems_status_code rtems_clock_get_uptime( struct timespec *uptime diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h index 5186fa1049..16544d8f95 100644 --- a/cpukit/rtems/include/rtems/rtems/dpmem.h +++ b/cpukit/rtems/include/rtems/rtems/dpmem.h @@ -72,6 +72,7 @@ typedef struct { } Dual_ported_memory_Control; /** + * @brief Define the internal Dual Ported Memory information * The following define the internal Dual Ported Memory information. */ RTEMS_DPMEM_EXTERN Objects_Information _Dual_ported_memory_Information; diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h index 10da6023d6..8c376c52e1 100644 --- a/cpukit/rtems/include/rtems/rtems/message.h +++ b/cpukit/rtems/include/rtems/rtems/message.h @@ -142,11 +142,11 @@ rtems_status_code rtems_message_queue_create( * extent of the search for the ID of the message queue named name. * The search can be limited to a particular node or allowed to * encompass all nodes. - * + * * @param[in] name is the user defined message queue name * @param[in] node is the node(s) to be searched * @param[in] id is the pointer to message queue id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * *id filled with the message queue id */ @@ -161,9 +161,9 @@ rtems_status_code rtems_message_queue_ident( * * This routine implements the rtems_message_queue_delete directive. The * message queue indicated by ID is deleted. - * + * * @param[in] id is the queue id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_message_queue_delete( @@ -173,6 +173,8 @@ rtems_status_code rtems_message_queue_delete( /** * @brief rtems_message_queue_send * + * Message Queue Manager - rtems_message_queue_send + * * This routine implements the rtems_message_queue_send directive. * This directive sends the message buffer to the message queue * indicated by ID. If one or more tasks is blocked waiting @@ -197,11 +199,11 @@ rtems_status_code rtems_message_queue_send( * except that if no tasks are waiting, the message buffer will * be placed at the FRONT of the chain of pending messages rather * than at the REAR. - * + * * @param[in] id is the pointer to message queue * @param[in] buffer is the pointer to message buffer * @param[in] size is the size of message to send urgently - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_message_queue_urgent( @@ -217,14 +219,14 @@ rtems_status_code rtems_message_queue_urgent( * This directive sends the message buffer to all of the tasks blocked * waiting for a message on the message queue indicated by ID. * If no tasks are waiting, then the message buffer will not be queued. - * + * * @param[in] id is the pointer to message queue * @param[in] buffer is the pointer to message buffer * @param[in] size is the size of message to broadcast * @param[in] count pointer to area to store number of threads made ready - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and - * *count filled in with number of threads made ready + * *count filled in with number of threads made ready */ rtems_status_code rtems_message_queue_broadcast( rtems_id id, @@ -269,6 +271,8 @@ rtems_status_code rtems_message_queue_receive( * This directive takes all outstanding messages for the message * queue indicated by ID and returns them to the inactive message * chain. The number of messages flushed is returned in COUNT. + * + * Message Queue Manager */ rtems_status_code rtems_message_queue_flush( rtems_id id, diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h index d8c1aa16f5..c59f1c98a8 100644 --- a/cpukit/rtems/include/rtems/rtems/object.h +++ b/cpukit/rtems/include/rtems/rtems/object.h @@ -73,6 +73,8 @@ typedef struct { /** * @brief Build Thirty-Two Bit Object Name * + * RTEMS Object Helper -- Build an Object Id + * * This function returns an object name composed of the four characters * C1, C2, C3, and C4. * @@ -135,6 +137,8 @@ char *rtems_object_get_name( * object. This can be used to set the name of objects * which do not have a naming scheme per their API. * + * RTEMS Object Helper -- Set Name of Object as String + * * @param[in] id is the Id of the object to obtain the name of * @param[out] name will be set to the name of the object * @@ -254,6 +258,7 @@ rtems_status_code rtems_object_set_name( * * @return This method returns the least valid value for * class number for the specified @a api. + * RTEMS Object Helper -- Get Least Valid Class for an API */ int rtems_object_api_minimum_class( int api diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h index ebdc845bea..ced0b052c4 100644 --- a/cpukit/rtems/include/rtems/rtems/part.h +++ b/cpukit/rtems/include/rtems/rtems/part.h @@ -31,6 +31,8 @@ * this header file. However by defining it to nothing, the data * declared in this header file can be instantiated. This is done * in a single per manager file. + * + * Partition Manager -- Instantiate Data */ #ifndef RTEMS_PART_EXTERN #define RTEMS_PART_EXTERN extern @@ -120,11 +122,11 @@ rtems_status_code rtems_partition_create( * extent of the search for the ID of the partition named name. * The search can be limited to a particular node or allowed to * encompass all nodes. - * + * * @param[in] name is the user defined partition name * @param[in] node is(are) the node(s) to be searched * @param[in] id is the pointer to partition id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * *id filled in with the partition id */ diff --git a/cpukit/rtems/include/rtems/rtems/partmp.h b/cpukit/rtems/include/rtems/rtems/partmp.h index 96decf9697..fee58e9038 100644 --- a/cpukit/rtems/include/rtems/rtems/partmp.h +++ b/cpukit/rtems/include/rtems/rtems/partmp.h @@ -65,6 +65,8 @@ typedef struct { /** * @brief Partition_MP_Send_process_packet * + * Multiprocessing Support for the Partition Manager + * * This routine performs a remote procedure call so that a * process operation can be performed on another node. */ diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h index 9b0d1de5f9..799ebbef08 100644 --- a/cpukit/rtems/include/rtems/rtems/ratemon.h +++ b/cpukit/rtems/include/rtems/rtems/ratemon.h @@ -50,6 +50,8 @@ * API calls. The statistics kept include minimum, maximum and average times * for both cpu usage and wall time. The statistics indicate the execution time * used by the owning thread between successive calls to rtems_rate_monotonic_period. + * + * Rate Monotonic Manager -- Reset Statistics for All Periods */ /**@{*/ @@ -312,12 +314,12 @@ rtems_status_code rtems_rate_monotonic_ident( * This routine implements the rtems_rate_monotonic_cancel directive. This * directive stops the period associated with ID from continuing to * run. - * + * * @param[in] id is the rate monotonic id - * + * * @return RTEMS_SUCCESSFUL if successful and caller is not the owning thread * or error code if unsuccessful - * + * */ rtems_status_code rtems_rate_monotonic_cancel( rtems_id id @@ -363,10 +365,10 @@ rtems_status_code rtems_rate_monotonic_get_status( * * This routine implements the rtems_rate_monotonic_get_statistics directive. * Statistics gathered from the use of this period are returned. - * + * * @param[in] id is the rate monotonic id * @param[in] statistics is the pointer to statistics control block - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_rate_monotonic_get_statistics( @@ -421,10 +423,10 @@ void rtems_rate_monotonic_report_statistics( void ); * length is non-zero, this directive initiates the period associated with * ID from continuing for a period of length. If length is zero, then * result is set to indicate the current state of the period. - * + * * @param[in] id is the rate monotonic id * @param[in] lenght is the length of period (in ticks) - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_rate_monotonic_period( @@ -441,7 +443,7 @@ rtems_status_code rtems_rate_monotonic_period( * period is restarted. If the owning thread is not waiting for the * period to expire, then the period is placed in the EXPIRED * state and not restarted. - * + * * @param[in] id is the period id */ void _Rate_monotonic_Timeout( diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h index b183b9dfcc..5ab0e47347 100644 --- a/cpukit/rtems/include/rtems/rtems/region.h +++ b/cpukit/rtems/include/rtems/rtems/region.h @@ -45,6 +45,10 @@ /**@{*/ /** + * @brief Instantiate RTEMS Region Data + * + * Region Manager -- Instantiate 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 @@ -84,6 +88,8 @@ RTEMS_REGION_EXTERN Objects_Information _Region_Information; /** * @brief _Region_Manager_initialization * + * Region Manager + * * This routine performs the initialization necessary for this manager. */ void _Region_Manager_initialization(void); @@ -91,6 +97,8 @@ void _Region_Manager_initialization(void); /** * @brief rtems_region_create * + * Region Manager + * * This routine implements the rtems_region_create directive. The * region will have the name name. The memory area managed by * the region is of length bytes and starts at starting_address. @@ -157,10 +165,10 @@ rtems_status_code rtems_region_ident( * This routine implements the rtems_region_get_information directive. * This directive returns information about the heap associated with * this region. - * + * * @param[in] id is the region id * @param[in] the_info is the pointer to region information block - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * *id filled with the region information block */ @@ -291,15 +299,15 @@ rtems_status_code rtems_region_return_segment( * 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] segmet is the pointer to segment address * @param[in] size is the new required size * @return RTEMS_SUCCESSFUL if operation successful, RTEMS_UNSATISFIED if the * the segment can't be resized in place or any other code atfailure - * + * * @note On RTEMS_SUCCESSFUL or RTEMS_UNSATISFIED exit it returns into the - * 'old_size' the old size in bytes of the user memory area of the + * 'old_size' the old size in bytes of the user memory area of the * specified segment. */ rtems_status_code rtems_region_resize_segment( @@ -317,7 +325,7 @@ rtems_status_code rtems_region_resize_segment( * This is a helper routine which is invoked any time memory is * freed. It looks at the set of waiting tasks and attempts to * satisfy all outstanding requests. - * + * * @param[in] the_region is the the region */ extern void _Region_Process_queue(Region_Control *the_region); diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h index 4fcf93e94c..984874037c 100644 --- a/cpukit/rtems/include/rtems/rtems/sem.h +++ b/cpukit/rtems/include/rtems/rtems/sem.h @@ -27,10 +27,15 @@ #define _RTEMS_RTEMS_SEM_H /** + * @brief Instantiate Semaphore Data + * + * Semaphore Manager -- Data Instantiation + * * 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 * in a single per manager file. + * */ #ifndef RTEMS_SEM_EXTERN #define RTEMS_SEM_EXTERN extern @@ -118,6 +123,8 @@ void _Semaphore_Manager_initialization(void); * the semaphore is count. The attribute_set determines if * the semaphore is global or local and the thread queue * discipline. It returns the id of the created semaphore in ID. + * + * Semaphore Manager */ rtems_status_code rtems_semaphore_create( rtems_name name, @@ -137,11 +144,11 @@ rtems_status_code rtems_semaphore_create( * extent of the search for the ID of the semaphore named name. * The search can be limited to a particular node or allowed to * encompass all nodes. - * + * * @param[in] name is the user defined semaphore name * @param[in] node is(are) the node(s) to be searched * @param[in] id is the pointer to semaphore id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * *id filled in with the semaphore id */ @@ -207,16 +214,16 @@ rtems_status_code rtems_semaphore_release( /** * @brief RTEMS Semaphore Flush - * + * * DESCRIPTION: * This package is the implementation of the flush directive * of the Semaphore Manager. - * + * * This directive allows a thread to flush the threads * pending on the semaphore. * * @param[in] id is the semaphore id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_semaphore_flush( diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h index 7ec65a9fbe..d3b34c4fbf 100644 --- a/cpukit/rtems/include/rtems/rtems/tasks.h +++ b/cpukit/rtems/include/rtems/rtems/tasks.h @@ -257,14 +257,14 @@ void _RTEMS_tasks_Manager_initialization(void); * The task's stack will be stack_size bytes. The task will begin * execution with initial_priority and initial_modes. It returns the * id of the created task in ID. - * + * * @param[in] name is the user defined thread name * @param[in] initial_priority is the thread priority * @param[in] stack_size is the stack size in bytes * @param[in] initial_modes is the initial thread mode * @param[in] attribute_set is the thread attributes * @param[in] id is the pointer to thread id - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful * and *id thread id filled in */ @@ -439,11 +439,11 @@ rtems_status_code rtems_task_resume( * current priority of the task associated with ID is set to * new_priority. The former priority of that task is returned * in old_priority. - * + * * @param[in] id is the thread to extract * @param[in] new_priority is the thread to extract * @param[in] old_priority is the thread to extract - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and * and *old_priority filled in with the previous previous priority */ @@ -472,9 +472,9 @@ rtems_status_code rtems_task_start( * This routine implements the rtems_task_wake_when directive. The * calling task is blocked until the current time of day is * equal to that indicated by time_buffer. - * + * * @param[in] time_buffer is the pointer to the time and date structure - * + * * @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful */ rtems_status_code rtems_task_wake_when( @@ -487,7 +487,7 @@ rtems_status_code rtems_task_wake_when( * This routine implements the rtems_task_wake_after directive. The * calling task is blocked until the indicated number of clock * ticks have occurred. - * + * * @param[in] ticks is the number of ticks to wait * @return RTEMS_SUCCESSFUL */ @@ -497,9 +497,11 @@ rtems_status_code rtems_task_wake_after( /** * @brief rtems_task_is_suspended - + * * This directive returns a status indicating whether or not * the specified task is suspended. + * + * RTEMS Task Manager */ rtems_status_code rtems_task_is_suspended( rtems_id id @@ -572,6 +574,8 @@ void _RTEMS_Tasks_Invoke_task_variable_dtor( * Input parameters: NONE * * Output parameters: NONE + * + * RTEMS Task Manager */ extern void _RTEMS_tasks_Initialize_user_tasks_body( void ); diff --git a/cpukit/rtems/src/clockgettod.c b/cpukit/rtems/src/clockgettod.c index dd68ec578d..18f7773912 100644 --- a/cpukit/rtems/src/clockgettod.c +++ b/cpukit/rtems/src/clockgettod.c @@ -1,6 +1,11 @@ -/* - * Clock Manager - rtems_clock_get_tod +/** + * @file * + * @brief Obtain Current Time of Day (Classic TOD) + * @ingroup ClassicClock Clocks + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/clockgetuptime.c b/cpukit/rtems/src/clockgetuptime.c index 05d2575b60..848fd34b04 100644 --- a/cpukit/rtems/src/clockgetuptime.c +++ b/cpukit/rtems/src/clockgetuptime.c @@ -1,6 +1,11 @@ -/* - * Clock Manager - get uptime +/** + * @file * + * @brief Obtain the System Uptime + * @ingroup ClassicClock Clocks + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/clockgetuptimeseconds.c b/cpukit/rtems/src/clockgetuptimeseconds.c index dc98d1d9e9..655a18e1e3 100644 --- a/cpukit/rtems/src/clockgetuptimeseconds.c +++ b/cpukit/rtems/src/clockgetuptimeseconds.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Returns the system uptime in seconds. + * @ingroup ClassicClock Clocks + */ + /* * Copyright (c) 2012 embedded brains GmbH. All rights reserved. * diff --git a/cpukit/rtems/src/clocksetnsecshandler.c b/cpukit/rtems/src/clocksetnsecshandler.c index 100db9b167..80cf1dd8e6 100644 --- a/cpukit/rtems/src/clocksetnsecshandler.c +++ b/cpukit/rtems/src/clocksetnsecshandler.c @@ -1,6 +1,11 @@ -/* - * Clock Manager +/** + * @file * + * @brief Set the BSP specific Nanoseconds Extension + * @ingroup ClassicClock Clocks + */ + +/* * COPYRIGHT (c) 1989-2006. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/dpmemdata.c b/cpukit/rtems/src/dpmemdata.c index 088fefea23..dac78730c7 100644 --- a/cpukit/rtems/src/dpmemdata.c +++ b/cpukit/rtems/src/dpmemdata.c @@ -1,6 +1,11 @@ -/* - * Dual Port Memory Manager -- Instantiate Data +/** + * @file * + * @brief Define the internal Dual Ported Memory information + * @ingroup ClassicDPMEM Dual Ported Memory + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/msgqflush.c b/cpukit/rtems/src/msgqflush.c index e62047ef0e..a14e96dae0 100644 --- a/cpukit/rtems/src/msgqflush.c +++ b/cpukit/rtems/src/msgqflush.c @@ -1,7 +1,11 @@ -/* - * Message Queue Manager - * +/** + * @file * + * @brief rtems_message_queue_flush + * @ingroup ClassicMessageQueue Message Queues + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/msgqsend.c b/cpukit/rtems/src/msgqsend.c index 5fbcfa1c0a..764859d745 100644 --- a/cpukit/rtems/src/msgqsend.c +++ b/cpukit/rtems/src/msgqsend.c @@ -1,6 +1,11 @@ -/* - * Message Queue Manager - rtems_message_queue_send +/** + * @file * + * @brief rtems_message_queue_send + * @ingroup ClassicMessageQueue Message Queues + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/partdata.c b/cpukit/rtems/src/partdata.c index 10332f1dba..b568c4dc0c 100644 --- a/cpukit/rtems/src/partdata.c +++ b/cpukit/rtems/src/partdata.c @@ -1,6 +1,11 @@ -/* - * Partition Manager -- Instantiate Data +/** + * @file * + * @brief Instantiate RTEMS Partition Data + * @ingroup ClassicPart Partitions + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/partmp.c b/cpukit/rtems/src/partmp.c index 6a1fbc9878..2928238924 100644 --- a/cpukit/rtems/src/partmp.c +++ b/cpukit/rtems/src/partmp.c @@ -1,7 +1,11 @@ -/* - * Multiprocessing Support for the Partition Manager - * +/** + * @file * + * @brief Partition_MP_Send_process_packet + * @ingroup ClassicPartMP Partition MP Support + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/ratemonresetall.c b/cpukit/rtems/src/ratemonresetall.c index 5a6fbd1b2b..b2ed414149 100644 --- a/cpukit/rtems/src/ratemonresetall.c +++ b/cpukit/rtems/src/ratemonresetall.c @@ -1,6 +1,11 @@ -/* - * Rate Monotonic Manager -- Reset Statistics for All Periods +/** + * @file * + * @brief rtems_rate_monotonic_reset_all_statistics + * @ingroup ClassicRateMon Rate Monotonic Scheduler + */ + +/* * COPYRIGHT (c) 1989-2010. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/region.c b/cpukit/rtems/src/region.c index 2fdc3ca222..309b3c6c00 100644 --- a/cpukit/rtems/src/region.c +++ b/cpukit/rtems/src/region.c @@ -1,7 +1,11 @@ -/* - * Region Manager - * +/** + * @file * + * @brief _Region_Manager_initialization + * @ingroup ClassicRegion Regions + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/regioncreate.c b/cpukit/rtems/src/regioncreate.c index f97c85a65f..753835536a 100644 --- a/cpukit/rtems/src/regioncreate.c +++ b/cpukit/rtems/src/regioncreate.c @@ -1,7 +1,11 @@ -/* - * Region Manager - * +/** + * @file * + * @brief rtems_region_create + * @ingroup ClassicRegion Regions + */ + +/* * COPYRIGHT (c) 1989-1999. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/regiondata.c b/cpukit/rtems/src/regiondata.c index 4f5c3da816..97fdc112f1 100644 --- a/cpukit/rtems/src/regiondata.c +++ b/cpukit/rtems/src/regiondata.c @@ -1,6 +1,11 @@ -/* - * Region Manager -- Instantiate Data +/** + * @file * + * @brief Instantiate RTEMS Region Data + * @ingroup ClassicRegion Regions + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/rtemsbuildid.c b/cpukit/rtems/src/rtemsbuildid.c index b72e145c73..7c2c48d5fe 100644 --- a/cpukit/rtems/src/rtemsbuildid.c +++ b/cpukit/rtems/src/rtemsbuildid.c @@ -1,6 +1,11 @@ -/* - * RTEMS Object Helper -- Build an Object Id +/** + * @file * + * @brief Build Object Id + * @ingroup ClassicClassInfo Object Class Information + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/rtemsobjectapiminimumclass.c b/cpukit/rtems/src/rtemsobjectapiminimumclass.c index 8b0e78ae7a..858bc37ddb 100644 --- a/cpukit/rtems/src/rtemsobjectapiminimumclass.c +++ b/cpukit/rtems/src/rtemsobjectapiminimumclass.c @@ -1,6 +1,11 @@ -/* - * RTEMS Object Helper -- Get Least Valid Class for an API +/** + * @file * + * @brief Get Lowest Valid Class Value + * @ingroup ClassicClassInfo Object Class Information + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/rtemsobjectsetname.c b/cpukit/rtems/src/rtemsobjectsetname.c index e67d77f3b4..2f61231031 100644 --- a/cpukit/rtems/src/rtemsobjectsetname.c +++ b/cpukit/rtems/src/rtemsobjectsetname.c @@ -1,6 +1,11 @@ -/* - * RTEMS Object Helper -- Set Name of Object as String +/** + * @file * + * @brief Set Name of Object + * @ingroup ClassicClassInfo Object Class Information + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/semcreate.c b/cpukit/rtems/src/semcreate.c index a25789064e..e7f7b77c50 100644 --- a/cpukit/rtems/src/semcreate.c +++ b/cpukit/rtems/src/semcreate.c @@ -1,20 +1,11 @@ -/* - * Semaphore Manager - * - * DESCRIPTION: - * - * This package is the implementation of the Semaphore Manager. - * This manager utilizes standard Dijkstra counting semaphores to provide - * synchronization and mutual exclusion capabilities. - * - * Directives provided are: - * - * + create a semaphore - * + get an ID of a semaphore - * + delete a semaphore - * + acquire a semaphore - * + release a semaphore +/** + * @file * + * @brief rtems_semaphore_create + * @ingroup ClassicSem Semaphores + */ + +/* * COPYRIGHT (c) 1989-2009. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/semdata.c b/cpukit/rtems/src/semdata.c index accab0ef44..d19f0cc876 100644 --- a/cpukit/rtems/src/semdata.c +++ b/cpukit/rtems/src/semdata.c @@ -1,6 +1,11 @@ -/* - * Semaphore Manager -- Data Instantiation +/** + * @file * + * @brief Instantiate Semaphore Data + * @ingroup ClassicSem Semaphores + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/taskinitusers.c b/cpukit/rtems/src/taskinitusers.c index 2f4f0f9345..30cc81ae05 100644 --- a/cpukit/rtems/src/taskinitusers.c +++ b/cpukit/rtems/src/taskinitusers.c @@ -1,7 +1,11 @@ -/* - * RTEMS Task Manager - * +/** + * @file * + * @brief _RTEMS_tasks_Initialize_user_tasks_body + * @ingroup ClassicTasks Tasks + */ + +/* * COPYRIGHT (c) 1989-2008. * On-Line Applications Research Corporation (OAR). * diff --git a/cpukit/rtems/src/taskissuspended.c b/cpukit/rtems/src/taskissuspended.c index 179c41e366..6a62dd5b2a 100644 --- a/cpukit/rtems/src/taskissuspended.c +++ b/cpukit/rtems/src/taskissuspended.c @@ -1,7 +1,11 @@ -/* - * RTEMS Task Manager - * +/** + * @file * + * @brief rtems_task_is_suspended + * @ingroup ClassicTasks Tasks + */ + +/* * COPYRIGHT (c) 1989-2007. * On-Line Applications Research Corporation (OAR). * -- cgit v1.2.3