Author: Alex Ivanov <<a href="mailto:alexivanov97@gmail.com">alexivanov97@gmail.com</a>><br><br><a href="http://www.google-melange.com/gci/task/view/google/gci2012/8019205">http://www.google-melange.com/gci/task/view/google/gci2012/8019205</a><br>
<div class="gmail_extra"><br><br><div class="gmail_quote">On Wed, Dec 5, 2012 at 10:52 AM, Gedare Bloom <span dir="ltr"><<a href="mailto:gedare@rtems.org" target="_blank">gedare@rtems.org</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">
diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h<br>index df0e6f2..4884d2c 100644<br>--- a/cpukit/rtems/include/rtems/rtems/barrier.h<br>+++ b/cpukit/rtems/include/rtems/rtems/barrier.h<br>
@@ -125,10 +125,12 @@ rtems_status_code rtems_barrier_ident(<br> );<br> <br> /**<br>- * @brief rtems_barrier_delete<br>+ * @brief RTEMS Delete Barrier<br> *<br> * This routine implements the rtems_barrier_delete directive. The<br>
- * barrier indicated by @a id is deleted.<br>+ * barrier indicated by @a id is deleted. The barrier is freed back to the<br>+ * inactive barrier chain.<br>+ *<br> *<br> * @param[in] id indicates the barrier to delete<br>
*<br>diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h<br>index a4cf251..e305b31 100644<br>--- a/cpukit/rtems/include/rtems/rtems/dpmem.h<br>+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h<br>
@@ -84,13 +84,24 @@ RTEMS_DPMEM_EXTERN Objects_Information _Dual_ported_memory_Information;<br> void _Dual_ported_memory_Manager_initialization(void);<br> <br> /**<br>- * @brief rtems_port_create<br>+ * @brief RTEMS Create Port<br>
*<br> * This routine implements the rtems_port_create directive. The port<br> * will have the name name. The port maps onto an area of dual ported<br> * memory of length bytes which has internal_start and external_start<br>
* as the internal and external starting addresses, respectively.<br> * It returns the id of the created port in ID.<br>+ * <br>+ * @param[in] name is the user defined port name<br>+ * @param[in] internal_start is the internal start address of port<br>
+ * @param[in] external_start is the external start address of port<br>+ * @param[in] length is the physical length in bytes<br>+ * @param[in] id is the address of port id to set<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>
+ * error. Otherwise, a status code is returned indicating the<br>+ * source of the error. If successful, the id will<br>+ * be filled in with the port id.<br> */<br> rtems_status_code rtems_port_create(<br>
rtems_name name,<br>@@ -118,10 +129,16 @@ rtems_status_code rtems_port_ident(<br> );<br> <br> /**<br>- * @brief rtems_port_delete<br>+ * @brief RTEMS Delete Port<br> *<br> * This routine implements the rtems_port_delete directive. It deletes<br>
* the port associated with ID.<br>+ * <br>+ * @param[in] id is the dual-ported memory area id<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>
+ * source of the error.<br> */<br> rtems_status_code rtems_port_delete(<br> rtems_id id<br>diff --git a/cpukit/rtems/include/rtems/rtems/modes.h b/cpukit/rtems/include/rtems/rtems/modes.h<br>index 0dbf91b..f80cb44 100644<br>
--- a/cpukit/rtems/include/rtems/rtems/modes.h<br>+++ b/cpukit/rtems/include/rtems/rtems/modes.h<br>@@ -102,7 +102,7 @@ typedef uint32_t Modes_Control;<br> extern const uint32_t rtems_interrupt_mask;<br> <br> /**<br>- * @brief Body for RTEMS_INTERRUPT_LEVEL macro.<br>
+ * @brief Body for RTEMS_INTERRUPT_LEVEL Macro<br> *<br> * @param[in] level is the desired interrupt level<br> *<br>diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h<br>
index b6b5b3a..d46be0a 100644<br>
--- a/cpukit/rtems/include/rtems/rtems/part.h<br>+++ b/cpukit/rtems/include/rtems/rtems/part.h<br>@@ -84,7 +84,7 @@ typedef struct {<br> RTEMS_PART_EXTERN Objects_Information _Partition_Information;<br> <br> /**<br>- * @brief Partition_Manager_initialization<br>
+ * @brief Partition Manager Initialization<br> *<br> * This routine performs the initialization necessary for this manager.<br> */<br>diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h<br>
index 055e25d..f58bdff 100644<br>--- a/cpukit/rtems/include/rtems/rtems/region.h<br>+++ b/cpukit/rtems/include/rtems/rtems/region.h<br>@@ -109,12 +109,20 @@ rtems_status_code rtems_region_create(<br> );<br> <br> /**<br>- * @brief rtems_region_extend<br>
+ * @brief RTEMS Extend Region<br> *<br> * This routine implements the rtems_region_extend directive. The<br> * region will have the name name. The memory area managed by<br> * the region will be attempted to be grown by length bytes using<br>
* the memory starting at starting_address.<br>+ * <br>+ * @param[in] id is the id of region to grow<br>+ * @param[in] starting_address starting address of memory area for extension<br>+ * @param[in] length is the physical length in bytes to grow the region<br>
+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>+ * source of the error.<br> */<br> rtems_status_code rtems_region_extend(<br>
rtems_id id,<br>@@ -123,12 +131,20 @@ rtems_status_code rtems_region_extend(<br> );<br> <br> /**<br>- * @brief rtems_region_ident<br>+ * @brief RTEMS Region Name to Id<br> *<br> * This routine implements the rtems_region_ident directive.<br>
* This directive returns the region ID associated with name.<br> * If more than one region is named name, then the region<br> * to which the ID belongs is arbitrary.<br>+ * <br>+ * @param[in] name is the user defined region name<br>
+ * @param[in] id is the pointer to region id<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>+ * source of the error. If successful, the id will<br>
+ * be filled in with the region id.<br> */<br> rtems_status_code rtems_region_ident(<br> rtems_name name,<br>@@ -166,10 +182,17 @@ rtems_status_code rtems_region_get_free_information(<br> );<br> <br> /**<br>
- * @brief rtems_region_delete<br>+ * @brief RTEMS Delete Region<br> *<br> * This routine implements the rtems_region_delete directive. The<br>- * region indicated by ID is deleted.<br>+ * region indicated by ID is deleted, provided that none of its segments are<br>
+ * still allocated.<br>+ * <br>+ * @param[in] id is the region id<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>
+ * source of the error.<br> */<br> rtems_status_code rtems_region_delete(<br> rtems_id id<br>@@ -206,10 +229,19 @@ rtems_status_code rtems_region_get_segment(<br> );<br> <br> /**<br>- * @brief rtems_region_get_segment_size<br>
+ * @brief RTEMS Get Region Segment Size<br> *<br> * This routine implements the rtems_region_get_segment_size directive. It<br> * returns the size in bytes of the specified user memory area.<br>+ * <br>+ * @param[in] id is the region id<br>
+ * @param[in] segment is the segment address<br>+ * @param[in] size is the pointer to segment size in bytes<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>
+ * source of the error. If successful, the size will<br>+ * be filled in with the segment size in bytes.<br> */<br> rtems_status_code rtems_region_get_segment_size(<br> rtems_id id,<br>diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h<br>
index 2322088..aedc5ea 100644<br>--- a/cpukit/rtems/include/rtems/rtems/sem.h<br>+++ b/cpukit/rtems/include/rtems/rtems/sem.h<br>@@ -229,20 +229,28 @@ bool _Semaphore_Seize(<br> );<br> <br> /**<br>- * @brief _Semaphore_Translate_core_mutex_return_code<br>
+ * @brief Semaphore Translate Core Mutex Return Code<br> *<br> * This function returns a RTEMS status code based on the mutex<br> * status code specified.<br>+ * <br>+ * @param[in] the_mutex_status is the mutex status code to translate<br>
+ * <br>+ * @return translated RTEMS status code<br> */<br> rtems_status_code _Semaphore_Translate_core_mutex_return_code (<br> uint32_t the_mutex_status<br> );<br> <br> /**<br>- * @brief _Semaphore_Translate_core_semaphore_return_code<br>
+ * @brief Semaphore Translate Core Semaphore Return Code<br> *<br> * This function returns a RTEMS status code based on the semaphore<br> * status code specified.<br>+ * <br>+ * @param[in] status is the semaphore status code to translate<br>
+ * <br>+ * @return translated RTEMS status code<br> */<br> rtems_status_code _Semaphore_Translate_core_semaphore_return_code (<br> uint32_t the_mutex_status<br>diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h<br>
index 90379c1..abd7d1f 100644<br>--- a/cpukit/rtems/include/rtems/rtems/tasks.h<br>+++ b/cpukit/rtems/include/rtems/rtems/tasks.h<br>@@ -278,7 +278,7 @@ rtems_status_code rtems_task_create(<br> );<br> <br> /**<br>- * @brief rtems_task_ident<br>
+ * @brief RTEMS Task Name to Id<br> *<br> * This routine implements the rtems_task_ident directive.<br> * This directive returns the task ID associated with name.<br>@@ -287,6 +287,15 @@ rtems_status_code rtems_task_create(<br>
* extent of the search for the ID of the task named name.<br> * The search can be limited to a particular node or allowed to<br> * encompass all nodes.<br>+ * <br>+ * @param[in] name is the user defined thread name<br>
+ * @param[in] node is(are) the node(s) to be searched<br>+ * @param[in] id is the pointer to thread id<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>
+ * source of the error. If successful, the id will<br>+ * be filled in with the thread id.<br> */<br> rtems_status_code rtems_task_ident(<br> rtems_name name,<br>@@ -295,10 +304,18 @@ rtems_status_code rtems_task_ident(<br>
);<br> <br> /**<br>- * @brief rtems_task_delete<br>+ * @brief RTEMS Delete Task<br> *<br> * This routine implements the rtems_task_delete directive. The<br>- * task indicated by ID is deleted.<br>+ * task indicated by ID is deleted. The executive halts execution<br>
+ * of the thread and frees the thread control block.<br>+ * <br>+ * @param[in] id is the thread id<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error and id is not the requesting thread. Status code is<br>
+ * returned indicating the source of the error. Nothing<br>+ * is returned if id is the requesting thread (always succeeds).<br> */<br> rtems_status_code rtems_task_delete(<br> rtems_id id<br>@@ -376,10 +393,17 @@ rtems_status_code rtems_task_restart(<br>
);<br> <br> /**<br>- * @brief rtems_task_suspend<br>+ * @brief RTEMS Suspend Task<br> *<br> * This routine implements the rtems_task_suspend directive. The<br>- * SUSPENDED state is set for task associated with ID.<br>
+ * SUSPENDED state is set for task associated with ID. Note that the<br>+ * suspended state can be in addition to other waiting states.<br>+ * <br>+ * @param[in] id is the thread id<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>
+ * error. Otherwise, a status code is returned indicating the<br>+ * source of the error.<br> */<br> rtems_status_code rtems_task_suspend(<br> rtems_id id<br>@@ -522,14 +546,10 @@ rtems_id rtems_task_self(void);<br>
void _RTEMS_tasks_Initialize_user_tasks( void );<br> <br> /**<br>- * @brief _RTEMS_Tasks_Invoke_task_variable_dtor<br>+ * @brief RTEMS Tasks Invoke Task Variable Destructor<br> *<br> * This routine invokes the optional user provided destructor on the<br>
* task variable and frees the memory for the task variable.<br>- *<br>- * Input parameters: NONE<br>- *<br>- * Output parameters: NONE<br> */<br> void _RTEMS_Tasks_Invoke_task_variable_dtor(<br> Thread_Control *the_thread,<br>
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h<br>index ee35fec..b7ab2e2 100644<br>--- a/cpukit/rtems/include/rtems/rtems/timer.h<br>+++ b/cpukit/rtems/include/rtems/rtems/timer.h<br>
@@ -222,7 +222,7 @@ RTEMS_TIMER_EXTERN Timer_server_Control *volatile _Timer_server;<br> RTEMS_TIMER_EXTERN Objects_Information _Timer_Information;<br> <br> /**<br>- * @brief _Timer_Manager_initialization<br>+ * @brief Timer Manager Initialization<br>
*<br> * This routine performs the initialization necessary for this manager.<br> */<br>@@ -301,13 +301,22 @@ rtems_status_code rtems_timer_fire_after(<br> );<br> <br> /**<br>- * @brief rtems_timer_server_fire_after<br>
+ * @brief RTEMS Timer Server Fire After<br> *<br> * This routine implements the rtems_timer_server_fire_after directive. It<br> * initiates the timer associated with ID to fire in ticks clock<br> * ticks. When the timer fires, the routine will be invoked by the<br>
* Timer Server in the context of a task NOT IN THE CONTEXT of the<br> * clock tick interrupt.<br>+ * <br>+ * @param[in] id is the timer id<br>+ * @param[in] ticks is the interval until routine is fired<br>+ * @param[in] routine is the routine to schedule<br>
+ * @param[in] user_data is the passed as argument to routine when it is fired<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>+ * error. Otherwise, a status code is returned indicating the<br>
+ * source of the error.<br> */<br> rtems_status_code rtems_timer_server_fire_after(<br> rtems_id id,<br>@@ -317,13 +326,22 @@ rtems_status_code rtems_timer_server_fire_after(<br> );<br>
<br> /**<br>- * @brief rtems_timer_fire_when<br>+ * @brief RTEMS Timer Fire When<br> *<br> * This routine implements the rtems_timer_fire_when directive. It<br> * initiates the timer associated with ID to fire at wall_time<br>
* When the timer fires, the routine will be invoked in the context<br> * of the rtems_clock_tick directive which is normally invoked as<br> * part of servicing a periodic interupt.<br>+ * <br>+ * @param[in] id is the timer id<br>
+ * @param[in] wall_time is the time of day to fire timer<br>+ * @param[in] routine is the routine to schedule<br>+ * @param[in] user_data is the passed as argument to routine when it is fired<br>+ * <br>+ * @return This method returns RTEMS_SUCCESSFUL if there was not an<br>
+ * error. Otherwise, a status code is returned indicating the<br>+ * source of the error.<br> */<br> rtems_status_code rtems_timer_fire_when(<br> rtems_id id,<br>diff --git a/cpukit/rtems/src/barrierdelete.c b/cpukit/rtems/src/barrierdelete.c<br>
index 9811773..a73846d 100644<br>--- a/cpukit/rtems/src/barrierdelete.c<br>+++ b/cpukit/rtems/src/barrierdelete.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Barrier Manager -- Delete a Barrier<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Delete Barrier<br>
+ * @ingroup ClassicBarrier<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -21,21 +26,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/score/threadq.h><br>
<br>-/*<br>- * rtems_barrier_delete<br>- *<br>- * This directive allows a thread to delete a barrier specified by<br>- * the barrier id. The barrier is freed back to the inactive<br>- * barrier chain.<br>- *<br>- * Input parameters:<br>
- * id - barrier id<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_barrier_delete(<br> rtems_id id<br>
)<br>diff --git a/cpukit/rtems/src/dpmemcreate.c b/cpukit/rtems/src/dpmemcreate.c<br>index 7ac6ae9..6987670 100644<br>--- a/cpukit/rtems/src/dpmemcreate.c<br>+++ b/cpukit/rtems/src/dpmemcreate.c<br>@@ -1,6 +1,11 @@<br>-/*<br>
- * Dual Port Memory Manager<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Create Port<br>+ * @ingroup ClassicDPMEM<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-1999.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -22,24 +27,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/rtems/dpmem.h><br> <br>-/*<br>- * rtems_port_create<br>- *<br>- * This directive creates a port into a dual-ported memory area.<br>
- *<br>- * Input parameters:<br>- * name - user defined port name<br>- * internal_start - internal start address of port<br>- * external_start - external start address of port<br>- * length - physical length in bytes<br>
- * id - address of port id to set<br>- *<br>- * Output parameters:<br>- * id - port id<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_port_create(<br>
rtems_name name,<br> void *internal_start,<br>diff --git a/cpukit/rtems/src/dpmemdelete.c b/cpukit/rtems/src/dpmemdelete.c<br>index 02c3fbb..4f78035 100644<br>--- a/cpukit/rtems/src/dpmemdelete.c<br>+++ b/cpukit/rtems/src/dpmemdelete.c<br>
@@ -1,6 +1,11 @@<br>-/*<br>- * Dual Port Memory Manager<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Delete Port<br>+ * @ingroup ClassicDPMEM<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -22,20 +27,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/rtems/dpmem.h><br> <br>-/*<br>- * rtems_port_delete<br>- *<br>- * This directive allows a thread to delete a dual-ported memory area<br>
- * specified by the dual-ported memory identifier.<br>- *<br>- * Input parameters:<br>- * id - dual-ported memory area id<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>
- */<br>-<br> rtems_status_code rtems_port_delete(<br> rtems_id id<br> )<br>diff --git a/cpukit/rtems/src/modes.c b/cpukit/rtems/src/modes.c<br>index 0c51281..6e4acff 100644<br>--- a/cpukit/rtems/src/modes.c<br>+++ b/cpukit/rtems/src/modes.c<br>
@@ -1,12 +1,11 @@<br> /**<br> * @file<br> *<br>- * @body Body for Mode Routines Implemented as Macros<br>- *<br>- * This file contains bodies for Mode Macros which are<br>- * needed by language bindings other than C and C++.<br>
+ * @brief Body for RTEMS_INTERRUPT_LEVEL Macro<br>+ * @ingroup ClassicModes<br> */<br> <br>+<br> /*<br> * COPYRIGHT (c) 1989-2012.<br> * On-Line Applications Research Corporation (OAR).<br>diff --git a/cpukit/rtems/src/part.c b/cpukit/rtems/src/part.c<br>
index 65e5331..042cdaf 100644<br>--- a/cpukit/rtems/src/part.c<br>+++ b/cpukit/rtems/src/part.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Partition Manager<br>+/**<br>+ * @file<br> *<br>+ * @brief Partition Manager Initialization<br>
+ * @ingroup ClassicPart<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -23,17 +28,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/score/sysstate.h><br>
<br>-/*<br>- * _Partition_Manager_initialization<br>- *<br>- * This routine initializes all partition manager related<br>- * data structures.<br>- *<br>- * Input parameters: NONE<br>- *<br>- * Output parameters: NONE<br>
- */<br>-<br> void _Partition_Manager_initialization(void)<br> {<br> _Objects_Initialize_information(<br>diff --git a/cpukit/rtems/src/regiondelete.c b/cpukit/rtems/src/regiondelete.c<br>index d691bed..8ad5085 100644<br>
--- a/cpukit/rtems/src/regiondelete.c<br>+++ b/cpukit/rtems/src/regiondelete.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Region Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Delete Region<br>+ * @ingroup ClassicRegion<br>
+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -24,21 +28,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/score/apimutex.h><br>
<br>-/*<br>- * rtems_region_delete<br>- *<br>- * This directive allows a thread to delete a region specified by<br>- * the region identifier, provided that none of its segments are<br>- * still allocated.<br>- *<br>
- * Input parameters:<br>
- * id - region id<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_region_delete(<br> rtems_id id<br>
)<br>diff --git a/cpukit/rtems/src/regionextend.c b/cpukit/rtems/src/regionextend.c<br>index 205534b..d5e3cd6 100644<br>--- a/cpukit/rtems/src/regionextend.c<br>+++ b/cpukit/rtems/src/regionextend.c<br>@@ -1,6 +1,11 @@<br>
-/*<br>- * Region Manager - Extend (add memory to) a Region<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Extend Region<br>+ * @ingroup ClassicRegion<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2009.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -23,22 +28,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/score/apimutex.h><br> <br>-/*<br>- * rtems_region_extend<br>- *<br>- * This directive attempts to grow a region of physical contiguous memory area<br>
- * from which variable sized segments can be allocated.<br>- *<br>- * Input parameters:<br>- * id - id of region to grow<br>- * start - starting address of memory area for extension<br>- * length - physical length in bytes to grow the region<br>
- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_region_extend(<br> rtems_id id,<br> void *starting_address,<br>
diff --git a/cpukit/rtems/src/regiongetsegmentsize.c b/cpukit/rtems/src/regiongetsegmentsize.c<br>index 8333d16..94a6686 100644<br>--- a/cpukit/rtems/src/regiongetsegmentsize.c<br>+++ b/cpukit/rtems/src/regiongetsegmentsize.c<br>
@@ -1,7 +1,11 @@<br>-/*<br>- * Region Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Get Region Segment Size<br>+ * @ingroup ClassicRegion<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -23,22 +27,6 @@<br> #include <rtems/score/states.h><br> #include <rtems/score/apimutex.h><br> <br>-/*<br>- * rtems_region_get_segment_size<br>- *<br>- * This directive will return the size of the segment indicated<br>
- *<br>- * Input parameters:<br>- * id - region id<br>- * segment - segment address<br>- * size - pointer to segment size in bytes<br>- *<br>- * Output parameters:<br>- * size - segment size in bytes filled in<br>
- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_region_get_segment_size(<br> rtems_id id,<br> void *segment,<br>diff --git a/cpukit/rtems/src/regionident.c b/cpukit/rtems/src/regionident.c<br>
index 6e18092..ca15664 100644<br>--- a/cpukit/rtems/src/regionident.c<br>+++ b/cpukit/rtems/src/regionident.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Region Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Region Name to Id<br>
+ * @ingroup ClassicRegion<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-1999.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -24,22 +28,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/score/apimutex.h><br>
<br>-/*<br>- * rtems_region_ident<br>- *<br>- * This directive returns the system ID associated with<br>- * the region name.<br>- *<br>- * Input parameters:<br>- * name - user defined region name<br>- * id - pointer to region id<br>
- *<br>- * Output parameters:<br>- * *id - region id<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_region_ident(<br> rtems_name name,<br>
rtems_id *id<br>diff --git a/cpukit/rtems/src/rtclock.c b/cpukit/rtems/src/rtclock.c<br>index 515788c..fb4cb35 100644<br>--- a/cpukit/rtems/src/rtclock.c<br>+++ b/cpukit/rtems/src/rtclock.c<br>@@ -1,6 +1,11 @@<br>-/*<br>
- * Clock Manager<br>+/**<br>+ * @file<br> *<br>+ * @brief No Initialization Routine<br>+ * @ingroup ClassicClock<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-1999.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>diff --git a/cpukit/rtems/src/rtemsobjectidgetnode.c b/cpukit/rtems/src/rtemsobjectidgetnode.c<br>index eb97a37..15f8cd8 100644<br>--- a/cpukit/rtems/src/rtemsobjectidgetnode.c<br>+++ b/cpukit/rtems/src/rtemsobjectidgetnode.c<br>
@@ -1,6 +1,11 @@<br>-/*<br>- * RTEMS Object Helper -- Extract Node From Id<br>+/**<br>+ * @file<br> *<br>+ * @brief Get Node Portion of Object Id<br>+ * @ingroup ClassicClassInfo<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br>
* On-Line Applications Research Corporation (OAR).<br> *<br>diff --git a/cpukit/rtems/src/rtemstimer.c b/cpukit/rtems/src/rtemstimer.c<br>index 6a8a3e0..6bf33c1 100644<br>--- a/cpukit/rtems/src/rtemstimer.c<br>+++ b/cpukit/rtems/src/rtemstimer.c<br>
@@ -1,7 +1,11 @@<br>-/*<br>- * Timer Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief Timer Manager Initialization<br>+ * @ingroup ClassicTimer<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -24,16 +28,6 @@<br> #include <rtems/score/tod.h><br> #include <rtems/score/watchdog.h><br> <br>-/*<br>- * _Timer_Manager_initialization<br>- *<br>- * This routine initializes all timer manager related data structures.<br>
- *<br>- * Input parameters: NONE<br>- *<br>- * Output parameters: NONE<br>- */<br>-<br> void _Timer_Manager_initialization(void)<br> {<br> _Objects_Initialize_information(<br>diff --git a/cpukit/rtems/src/semtranslatereturncode.c b/cpukit/rtems/src/semtranslatereturncode.c<br>
index 2231df8..a06a848 100644<br>--- a/cpukit/rtems/src/semtranslatereturncode.c<br>+++ b/cpukit/rtems/src/semtranslatereturncode.c<br>@@ -1,20 +1,11 @@<br>-/*<br>- * Semaphore Manager<br>- *<br>- * DESCRIPTION:<br>- *<br>
- * This package is the implementation of the Semaphore Manager.<br>- * This manager utilizes standard Dijkstra counting semaphores to provide<br>- * synchronization and mutual exclusion capabilities.<br>- *<br>- * Directives provided are:<br>
- *<br>- * + create a semaphore<br>- * + get an ID of a semaphore<br>- * + delete a semaphore<br>- * + acquire a semaphore<br>- * + release a semaphore<br>+/**<br>+ * @file<br> *<br>+ * @brief Semaphore Translate Core Mutex and Semaphore Return Code<br>
+ * @ingroup ClassicSem<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2009.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -47,17 +38,6 @@<br> <br> #include <rtems/score/interr.h><br> <br>-/*<br>
- * _Semaphore_Translate_core_mutex_return_code<br>- *<br>- * Input parameters:<br>- * status - mutex status code to translate<br>- *<br>- * Output parameters:<br>- * rtems status code - translated RTEMS status code<br>
- *<br>- */<br>-<br> const rtems_status_code _Semaphore_Translate_core_mutex_return_code_[] = {<br> RTEMS_SUCCESSFUL, /* CORE_MUTEX_STATUS_SUCCESSFUL */<br> RTEMS_UNSATISFIED, /* CORE_MUTEX_STATUS_UNSATISFIED_NOWAIT */<br>
@@ -95,17 +75,6 @@ rtems_status_code _Semaphore_Translate_core_mutex_return_code (<br> return _Semaphore_Translate_core_mutex_return_code_[status];<br> }<br> <br>-/*<br>- * _Semaphore_Translate_core_semaphore_return_code<br>
- *<br>- * Input parameters:<br>- * status - semaphore status code to translate<br>- *<br>- * Output parameters:<br>- * rtems status code - translated RTEMS status code<br>- *<br>- */<br>-<br> const rtems_status_code _Semaphore_Translate_core_semaphore_return_code_[] = {<br>
RTEMS_SUCCESSFUL, /* CORE_SEMAPHORE_STATUS_SUCCESSFUL */<br> RTEMS_UNSATISFIED, /* CORE_SEMAPHORE_STATUS_UNSATISFIED_NOWAIT */<br>diff --git a/cpukit/rtems/src/taskdelete.c b/cpukit/rtems/src/taskdelete.c<br>
index 5204569..2f78301 100644<br>--- a/cpukit/rtems/src/taskdelete.c<br>+++ b/cpukit/rtems/src/taskdelete.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * RTEMS Task Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Delete Task<br>
+ * @ingroup ClassicTasks<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -30,23 +34,6 @@<br> #include <rtems/score/sysstate.h><br> #include <rtems/score/apimutex.h><br>
<br>-/*<br>- * rtems_task_delete<br>- *<br>- * This directive allows a thread to delete itself or the thread<br>- * identified in the id field. The executive halts execution<br>- * of the thread and frees the thread control block.<br>
- *<br>- * Input parameters:<br>- * id - thread id<br>- *<br>- * Output parameters:<br>- * nothing - if id is the requesting thread (always succeeds)<br>- * RTEMS_SUCCESSFUL - if successful and id is<br>
- * not the requesting thread<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_task_delete(<br> rtems_id id<br> )<br>diff --git a/cpukit/rtems/src/taskident.c b/cpukit/rtems/src/taskident.c<br>
index 570aa35..2c30909 100644<br>--- a/cpukit/rtems/src/taskident.c<br>+++ b/cpukit/rtems/src/taskident.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * RTEMS Task Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Task Name to Id<br>
+ * @ingroup ClassicTasks<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-1999.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -29,23 +33,6 @@<br> #include <rtems/score/apiext.h><br> #include <rtems/score/sysstate.h><br>
<br>-/*<br>- * rtems_task_ident<br>- *<br>- * This directive returns the system ID associated with<br>- * the thread name.<br>- *<br>- * Input parameters:<br>- * name - user defined thread name<br>- * node - node(s) to be searched<br>
- * id - pointer to thread id<br>- *<br>- * Output parameters:<br>- * *id - thread id<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_task_ident(<br>
rtems_name name,<br> uint32_t node,<br>diff --git a/cpukit/rtems/src/tasksuspend.c b/cpukit/rtems/src/tasksuspend.c<br>index e1e82dd..8128100 100644<br>--- a/cpukit/rtems/src/tasksuspend.c<br>+++ b/cpukit/rtems/src/tasksuspend.c<br>
@@ -1,7 +1,11 @@<br>-/*<br>- * RTEMS Task Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Suspend Task<br>+ * @ingroup ClassicTasks<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -29,21 +33,6 @@<br> #include <rtems/score/apiext.h><br> #include <rtems/score/sysstate.h><br> <br>-/*<br>- * rtems_task_suspend<br>- *<br>- * This directive will place the specified thread in the "suspended"<br>
- * state. Note that the suspended state can be in addition to<br>- * other waiting states.<br>- *<br>- * Input parameters:<br>- * id - thread id<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>
- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_task_suspend(<br> rtems_id id<br> )<br>diff --git a/cpukit/rtems/src/taskvariable_invoke_dtor.c b/cpukit/rtems/src/taskvariable_invoke_dtor.c<br>
index 9f797c4..76fc268 100644<br>--- a/cpukit/rtems/src/taskvariable_invoke_dtor.c<br>+++ b/cpukit/rtems/src/taskvariable_invoke_dtor.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Invoke the destructor on a per-task variable<br>- *<br>
+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Tasks Invoke Task Variable Destructor<br>+ * @ingroup ClassicTasks<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>diff --git a/cpukit/rtems/src/timerfirewhen.c b/cpukit/rtems/src/timerfirewhen.c<br>index df24e2a..487471f 100644<br>--- a/cpukit/rtems/src/timerfirewhen.c<br>+++ b/cpukit/rtems/src/timerfirewhen.c<br>@@ -1,7 +1,11 @@<br>
-/*<br>- * Timer Manager - rtems_timer_fire_when directive<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Timer Fire When<br>+ * @ingroup ClassicTimer<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -23,22 +27,6 @@<br> #include <rtems/score/tod.h><br> #include <rtems/score/watchdog.h><br> <br>-/*<br>- * rtems_timer_fire_when<br>- *<br>- * This directive allows a thread to start a timer.<br>- *<br>
- * Input parameters:<br>- * id - timer id<br>- * wall_time - time of day to fire timer<br>- * routine - routine to schedule<br>- * user_data - passed as argument to routine when it is fired<br>- *<br>
- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_timer_fire_when(<br> rtems_id id,<br> rtems_time_of_day *wall_time,<br>
diff --git a/cpukit/rtems/src/timerserverfireafter.c b/cpukit/rtems/src/timerserverfireafter.c<br>index d515d5f..ee8dc8f 100644<br>--- a/cpukit/rtems/src/timerserverfireafter.c<br>+++ b/cpukit/rtems/src/timerserverfireafter.c<br>
@@ -1,7 +1,11 @@<br>-/*<br>- * Timer Manager - rtems_timer_server fire_after directive<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Timer Server Fire After<br>+ * @ingroup ClassicTimer<br>+ */<br>+<br>+/*<br>
* COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -23,23 +27,6 @@<br> #include <rtems/score/tod.h><br> #include <rtems/score/watchdog.h><br> <br>-/*<br>- * rtems_timer_server_fire_after<br>
- *<br>- * This directive allows a thread to start a timer which will by<br>- * executed by the Timer Server when it fires.<br>- *<br>- * Input parameters:<br>- * id - timer id<br>- * ticks - interval until routine is fired<br>
- * routine - routine to schedule<br>- * user_data - passed as argument to routine when it is fired<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>
- */<br>-<br> rtems_status_code rtems_timer_server_fire_after(<br> rtems_id id,<br> rtems_interval ticks,<br>
</blockquote></div><br></div>