Author: Alex Ivanov <<a href="mailto:alexivanov97@gmail.com" target="_blank">alexivanov97@gmail.com</a>><br><br><a href="http://www.google-melange.com/gci/task/view/google/gci2012/7950206">http://www.google-melange.com/gci/task/view/google/gci2012/7950206</a><br>
<div class="gmail_extra"><br><br><div class="gmail_quote">On Wed, Dec 5, 2012 at 1:39 PM, 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/clock.h b/cpukit/rtems/include/rtems/rtems/clock.h<br>index c841d1a..fc6a584 100644<br>--- a/cpukit/rtems/include/rtems/rtems/clock.h<br>+++ b/cpukit/rtems/include/rtems/rtems/clock.h<br>
@@ -243,7 +243,7 @@ void rtems_clock_get_uptime_timeval( struct timeval *uptime );<br> time_t rtems_clock_get_uptime_seconds( void );<br> <br> /**<br>- * @brief _TOD_Validate<br>+ * @brief TOD Validate<br> *<br> * This support function returns true if @a the_tod contains<br>
* a valid time of day, and false otherwise.<br>@@ -251,6 +251,8 @@ time_t rtems_clock_get_uptime_seconds( void );<br> * @param[in] the_tod is the TOD structure to validate<br> *<br> * @return This method returns true if the TOD is valid and false otherwise.<br>
+ * <br>+ * @note This routine only works for leap-years through 2099.<br> */<br> bool _TOD_Validate(<br> const rtems_time_of_day *the_tod<br>diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h<br>
index a4cf251..2041ddd 100644<br>--- a/cpukit/rtems/include/rtems/rtems/dpmem.h<br>+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h<br>@@ -149,11 +149,20 @@ rtems_status_code rtems_port_external_to_internal(<br> );<br> <br>
/**<br>- * @brief rtems_port_internal_to_external<br>+ * @brief RTEMS Port Internal to External<br> *<br> * This routine implements the Port_internal_to_external directive.<br> * It returns the external port address which maps to the provided<br>
- * internal port address for the specified port ID.<br>+ * internal port address for the specified port ID. If the given<br>+ * internal address is an invalid dual-ported address, then the<br>+ * external address is set to the given internal address.<br>
+ * <br>+ * @param[in] id is the id of dual-ported memory object<br>+ * @param[in] internal is the internal address to set<br>+ * @param[in] external is the pointer to external address<br>+ * <br>+ * @return RTEMS_SUCCESSFUL and the external will be filled in <br>
+ * with the external addresses<br> */<br> rtems_status_code rtems_port_internal_to_external(<br> rtems_id id,<br>diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h<br>
index 9990b14..10da602 100644<br>--- a/cpukit/rtems/include/rtems/rtems/message.h<br>+++ b/cpukit/rtems/include/rtems/rtems/message.h<br>@@ -234,7 +234,7 @@ rtems_status_code rtems_message_queue_broadcast(<br> );<br> <br>
/**<br>- * @brief rtems_message_queue_receive<br>+ * @brief RTEMS Message Queue Receive<br> *<br> * This routine implements the rtems_message_queue_receive directive.<br> * This directive is invoked when the calling task wishes to receive<br>
@@ -242,7 +242,17 @@ rtems_status_code rtems_message_queue_broadcast(<br> * message is to be placed in buffer. If no messages are outstanding<br> * and the option_set indicates that the task is willing to block,<br>
* then the task will be blocked until a message arrives or until,<br>
- * optionally, timeout clock ticks have passed.<br>+ * optionally, timeout clock ticks have passed. <br>+ * <br>+ * @param[in] id is the queue id<br>+ * @param[in] buffer is the pointer to message buffer<br>+ * @param[in] size is the size of message receive<br>
+ * @param[in] option_set is the options on receive<br>+ * @param[in] timeout is the number of ticks to wait<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_message_queue_receive(<br> rtems_id id,<br>diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h<br>
index b6b5b3a..88af1eb 100644<br>
--- a/cpukit/rtems/include/rtems/rtems/part.h<br>+++ b/cpukit/rtems/include/rtems/rtems/part.h<br>@@ -135,10 +135,17 @@ rtems_status_code rtems_partition_ident(<br> );<br> <br> /**<br>- * @brief rtems_partition_delete<br>
+ * @brief RTEMS Delete Partition<br> *<br> * This routine implements the rtems_partition_delete directive. The<br>- * partition indicated by ID is deleted.<br>+ * partition indicated by ID is deleted, provided that none of its buffers<br>
+ * are still allocated.<br>+ * <br>+ * @param[in] id is the partition 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_partition_delete(<br> rtems_id id<br>diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h<br>index 93c8e26..9b0d1de 100644<br>
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h<br>+++ b/cpukit/rtems/include/rtems/rtems/ratemon.h<br>@@ -269,6 +269,8 @@ RTEMS_RATEMON_EXTERN Objects_Information _Rate_monotonic_Information;<br> * @brief Rate Monotonic Manager Initialization<br>
*<br> * This routine performs the initialization necessary for this manager.<br>+ * <br>+ * @note The Rate Monotonic Manager is built on top of the Watchdog Handler<br> */<br> void _Rate_monotonic_Manager_initialization(void);<br>
<br>@@ -285,11 +287,19 @@ rtems_status_code rtems_rate_monotonic_create(<br> );<br> <br> /**<br>- * @brief rtems_rate_monotonic_ident<br>+ * @brief RTEMS Rate Monotonic Name to Id<br> *<br> * This routine implements the rtems_rate_monotonic_ident directive.<br>
* It returns the period ID associated with name. If more than one period<br> * is named name, then the period to which the ID belongs is arbitrary.<br>+ * <br>+ * @param[in] name is the user defined period name<br>
+ * @param[in] id is the pointer to period 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_rate_monotonic_ident(<br> rtems_name name,<br>@@ -314,10 +324,16 @@ rtems_status_code rtems_rate_monotonic_cancel(<br> );<br> <br> /**<br>
- * @brief rtems_rate_monotonic_delete<br>+ * @brief RTEMS Delete Rate Monotonic<br> *<br> * This routine implements the rtems_rate_monotonic_delete directive. The<br> * period indicated by ID is deleted.<br>+ * <br>
+ * @param[in] id is the rate monotonic 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_rate_monotonic_delete(<br> rtems_id id<br>@@ -328,6 +344,13 @@ rtems_status_code rtems_rate_monotonic_delete(<br> *<br> * This routine implements the rtems_rate_monotonic_get_status directive.<br>
* Information about the period indicated by ID is returned.<br>+ * <br>+ * @param[in] id is the rate monotonic id<br>+ * @param[in] status is the pointer to status control block<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> */<br> rtems_status_code rtems_rate_monotonic_get_status(<br>@@ -370,10 +393,13 @@ rtems_status_code rtems_rate_monotonic_reset_statistics(<br>
void rtems_rate_monotonic_reset_all_statistics( void );<br> <br> /**<br>- * @brief rtems_rate_monotonic_report_statistics<br>+ * @brief RTEMS Report Rate Monotonic Statistics<br> *<br> * This routine allows a thread to print the statistics information<br>
* on ALL period instances which have non-zero counts using printk.<br>+ * The implementation of this directive straddles the fence between<br>+ * inside and outside of RTEMS. It is presented as part of the Manager<br>
+ * but actually uses other services of the Manager.<br> */<br> void rtems_rate_monotonic_report_statistics_with_plugin(<br> void *context,<br>@@ -381,7 +407,7 @@ void rtems_rate_monotonic_report_statistics_with_plugin(<br>
);<br> <br> /**<br>- * @brief rtems_rate_monotonic_report_statistics<br>+ * @brief RTEMS Report Rate Monotonic Statistics<br> *<br> * This routine allows a thread to print the statistics information<br> * on ALL period instances which have non-zero counts using printk.<br>
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h<br>index 055e25d..269725a 100644<br>--- a/cpukit/rtems/include/rtems/rtems/region.h<br>+++ b/cpukit/rtems/include/rtems/rtems/region.h<br>
@@ -154,11 +154,20 @@ rtems_status_code rtems_region_get_information(<br> );<br> <br> /**<br>- * @brief rtems_region_get_free_information<br>+ * @brief RTEMS Get Region Free Information<br> *<br> * This routine implements the rtems_region_get_free_information directive.<br>
* This directive returns information about the free blocks in the<br>- * heap associated with this region.<br>+ * heap associated with this region. Information about the used blocks<br>+ * will be returned as zero.<br>
+ * <br>+ * @param[in] id is the region id<br>+ * @param[in] the_info is the pointer to region information block<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 the_info will<br>+ * be filled in with the region information block.<br> */<br> rtems_status_code rtems_region_get_free_information(<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..3ab9a65 100644<br>--- a/cpukit/rtems/include/rtems/rtems/sem.h<br>+++ b/cpukit/rtems/include/rtems/rtems/sem.h<br>
@@ -168,7 +168,7 @@ rtems_status_code rtems_semaphore_delete(<br> );<br> <br> /**<br>- * @brief rtems_semaphore_obtain<br>+ * @brief RTEMS Obtain Semaphore<br> *<br> * This routine implements the rtems_semaphore_obtain directive. It<br>
* attempts to obtain a unit from the semaphore associated with ID.<br>@@ -177,6 +177,14 @@ rtems_status_code rtems_semaphore_delete(<br> * block waiting for a unit with an optional timeout of timeout<br> * clock ticks. Whether the task blocks or returns immediately<br>
* is based on the RTEMS_NO_WAIT option in the option_set.<br>+ * <br>+ * @param[in] id is the semaphore id<br>+ * @param[in] option_set is the wait option<br>+ * @param[in] timeout is the number of ticks to wait (0 means wait forever)<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_semaphore_obtain(<br>
rtems_id id,<br>diff --git a/cpukit/rtems/include/rtems/rtems/support.h b/cpukit/rtems/include/rtems/rtems/support.h<br>index 99bf405..30716de 100644<br>--- a/cpukit/rtems/include/rtems/rtems/support.h<br>+++ b/cpukit/rtems/include/rtems/rtems/support.h<br>
@@ -63,7 +63,7 @@ extern "C" {<br> */<br> <br> /**<br>- * @brief Gets workspace information.<br>+ * @brief Gets Workspace Information<br> *<br> * Returns information about the heap that is used as the RTEMS Executive<br>
* Workspace in @a the_info.<br>@@ -75,7 +75,7 @@ bool rtems_workspace_get_information(<br> );<br> <br> /**<br>- * @brief Allocates memory from the workspace.<br>+ * @brief Allocates Memory from the Workspace<br> *<br>
* A number of @a bytes bytes will be allocated from the RTEMS Executive<br>
* Workspace and returned in @a pointer.<br>@@ -88,7 +88,7 @@ bool rtems_workspace_allocate(<br> );<br> <br> /**<br>- * @brief Frees memory allocated from the workspace.<br>+ * @brief Frees Memory Allocated from the Workspace<br>
*<br> * This frees the memory indicated by @a pointer that was allocated from the<br> * RTEMS Executive Workspace.<br>diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h<br>
index 90379c1..dd3f20f 100644<br>--- a/cpukit/rtems/include/rtems/rtems/tasks.h<br>+++ b/cpukit/rtems/include/rtems/rtems/tasks.h<br>@@ -345,12 +345,19 @@ rtems_status_code rtems_task_set_note(<br> );<br> <br> /**<br>- * @brief rtems_task_mode<br>
+ * @brief RTEMS Task Mode<br> *<br> * This routine implements the rtems_task_mode directive. The current<br> * values of the modes indicated by mask of the calling task are changed<br> * to that indicated in mode_set. The former mode of the task is<br>
* returned in mode_set.<br>+ * <br>+ * @param[in] mode_set is the new mode<br>+ * @param[in] mask is the mask<br>+ * @param[in] previous_mode_set is the address of previous mode set<br>+ * <br>+ * @return RTEMS_SUCCESSFUL and previous_mode_set filled in with the <br>
+ * previous mode set<br> */<br> rtems_status_code rtems_task_mode(<br> rtems_mode mode_set,<br>@@ -475,7 +482,7 @@ rtems_status_code rtems_task_is_suspended(<br> );<br> <br> /**<br>- * @brief rtems_task_variable_add<br>
+ * @brief RTEMS Add Task Variable<br> *<br> * This directive adds a per task variable.<br> */<br>diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h<br>index ee35fec..e125f82 100644<br>
--- a/cpukit/rtems/include/rtems/rtems/timer.h<br>+++ b/cpukit/rtems/include/rtems/rtems/timer.h<br>@@ -275,23 +275,38 @@ rtems_status_code rtems_timer_cancel(<br> );<br> <br> /**<br>- * @brief rtems_timer_delete<br>+ * @brief RTEMS Delete Timer<br>
*<br> * This routine implements the rtems_timer_delete directive. The<br> * timer indicated by ID is deleted.<br>+ * <br>+ * @param[in] id is the timer 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_timer_delete(<br> rtems_id id<br> );<br> <br> /**<br>- * @brief rtems_timer_fire_after<br>
+ * @brief RTEMS Timer Fire After<br> *<br> * This routine implements the rtems_timer_fire_after directive. It<br> * initiates the timer associated with ID to fire in ticks clock ticks.<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] 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_fire_after(<br> rtems_id id,<br>diff --git a/cpukit/rtems/src/clockgettickssinceboot.c b/cpukit/rtems/src/clockgettickssinceboot.c<br>
index 96a1c5e..cfd91b5 100644<br>--- a/cpukit/rtems/src/clockgettickssinceboot.c<br>+++ b/cpukit/rtems/src/clockgettickssinceboot.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Clock Manager - Get Ticks Since Boot<br>+/**<br>+ * @file<br>
*<br>+ * @brief Obtain Ticks Since Boot<br>+ * @ingroup ClassicClock<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>diff --git a/cpukit/rtems/src/clocktodvalidate.c b/cpukit/rtems/src/clocktodvalidate.c<br>
index 7aa854c..a56b1df 100644<br>--- a/cpukit/rtems/src/clocktodvalidate.c<br>+++ b/cpukit/rtems/src/clocktodvalidate.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Time of Day (TOD) Handler -- Validate Classic TOD<br>- *<br>+/**<br>
+ * @file<br> *<br>+ * @brief TOD Validate<br>+ * @ingroup ClassicClock<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -29,21 +33,6 @@ const uint32_t _TOD_Days_per_month[ 2 ][ 13 ] = {<br>
{ 0, 31, 29, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31 }<br> };<br> <br>-/*<br>- * _TOD_Validate<br>- *<br>- * This kernel routine checks the validity of a date and time structure.<br>- *<br>- * Input parameters:<br>- * the_tod - pointer to a time and date structure<br>
- *<br>- * Output parameters:<br>- * true - if the date, time, and tick are valid<br>- * false - if the the_tod is invalid<br>- *<br>- * NOTE: This routine only works for leap-years through 2099.<br>- */<br>-<br>
bool _TOD_Validate(<br> const rtems_time_of_day *the_tod<br> )<br>diff --git a/cpukit/rtems/src/dpmeminternal2external.c b/cpukit/rtems/src/dpmeminternal2external.c<br>index 6e61566..a6c8d83 100644<br>--- a/cpukit/rtems/src/dpmeminternal2external.c<br>
+++ b/cpukit/rtems/src/dpmeminternal2external.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Dual Port Memory Manager<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Port Internal to External<br>+ * @ingroup ClassicDPMEM<br>+ */<br>
+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<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_internal_to_external<br>- *<br>- * This directive converts an internal dual-ported memory address to an<br>- * external dual-ported memory address. If the given internal address<br>- * is an invalid dual-ported address, then the external address is set<br>
- * to the given internal address.<br>- *<br>- * Input parameters:<br>- * id - id of dual-ported memory object<br>- * internal - internal address to set<br>- * external - pointer to external address<br>- *<br>
- * Output parameters:<br>- * external - external address<br>- * RTEMS_SUCCESSFUL - always succeeds<br>- */<br>-<br> rtems_status_code rtems_port_internal_to_external(<br> rtems_id id,<br> void *internal,<br>
diff --git a/cpukit/rtems/src/msgqreceive.c b/cpukit/rtems/src/msgqreceive.c<br>index 00ed6c2..6be06ad 100644<br>--- a/cpukit/rtems/src/msgqreceive.c<br>+++ b/cpukit/rtems/src/msgqreceive.c<br>@@ -1,7 +1,11 @@<br>-/*<br>
- * Message Queue Manager<br>
- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Message Queue Receive<br>+ * @ingroup ClassicMessageQueue<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -32,24 +36,6 @@<br> #include <rtems/rtems/options.h><br> #include <rtems/rtems/support.h><br> <br>-/*<br>- * rtems_message_queue_receive<br>- *<br>- * This directive dequeues a message from the designated message queue<br>
- * and copies it into the requesting thread's buffer.<br>- *<br>- * Input parameters:<br>- * id - queue id<br>- * buffer - pointer to message buffer<br>- * size - size of message receive<br>
- * option_set - options on receive<br>- * timeout - number of ticks to wait<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br>
rtems_status_code rtems_message_queue_receive(<br> rtems_id id,<br> void *buffer,<br>diff --git a/cpukit/rtems/src/partdelete.c b/cpukit/rtems/src/partdelete.c<br>index 6cae308..6aeee4e 100644<br>--- a/cpukit/rtems/src/partdelete.c<br>
+++ b/cpukit/rtems/src/partdelete.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Partition Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Delete Partition<br>+ * @ingroup ClassicPart<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br>
* On-Line Applications Research Corporation (OAR).<br> *<br>@@ -23,21 +27,6 @@<br> #include <rtems/score/thread.h><br> #include <rtems/score/sysstate.h><br> <br>-/*<br>- * rtems_partition_delete<br>- *<br>
- * This directive allows a thread to delete a partition specified by<br>- * the partition identifier, provided that none of its buffers are<br>- * still allocated.<br>- *<br>- * Input parameters:<br>- * id - partition id<br>
- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_partition_delete(<br> rtems_id id<br> )<br>diff --git a/cpukit/rtems/src/ratemon.c b/cpukit/rtems/src/ratemon.c<br>
index d2eba80..d96a9b0 100644<br>--- a/cpukit/rtems/src/ratemon.c<br>+++ b/cpukit/rtems/src/ratemon.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Rate Monotonic Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief Rate Monotonic Manager Initialization<br>
+ * @ingroup ClassicRateMon<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -23,20 +27,6 @@<br> #include <rtems/rtems/ratemon.h><br> #include <rtems/score/thread.h><br>
<br>-/*<br>- * _Rate_monotonic_Manager_initialization<br>- *<br>- * This routine initializes all Rate Monotonic Manager related<br>- * data structures.<br>- *<br>- * Input parameters: NONE<br>- *<br>- * Output parameters: NONE<br>
- *<br>- * NOTE: The Rate Monotonic Manager is built on top of the Watchdog<br>- * Handler.<br>- */<br>-<br> void _Rate_monotonic_Manager_initialization(void)<br> {<br> _Objects_Initialize_information(<br>diff --git a/cpukit/rtems/src/ratemondelete.c b/cpukit/rtems/src/ratemondelete.c<br>
index 751c7f5..15498ea 100644<br>--- a/cpukit/rtems/src/ratemondelete.c<br>+++ b/cpukit/rtems/src/ratemondelete.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Rate Monotonic Manager -- Delete a Period<br>+/**<br>+ * @file<br> *<br>
+ * @brief RTEMS Delete Rate Monotonic<br>+ * @ingroup ClassicRateMon<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -21,19 +26,6 @@<br> #include <rtems/rtems/ratemon.h><br>
#include <rtems/score/thread.h><br> <br>-/*<br>- * rtems_rate_monotonic_delete<br>- *<br>- * This directive allows a thread to delete a rate monotonic timer.<br>- *<br>- * Input parameters:<br>- * id - rate monotonic id<br>
- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_rate_monotonic_delete(<br> rtems_id id<br> )<br>diff --git a/cpukit/rtems/src/ratemongetstatus.c b/cpukit/rtems/src/ratemongetstatus.c<br>
index 73c59ee..5d0d584 100644<br>--- a/cpukit/rtems/src/ratemongetstatus.c<br>+++ b/cpukit/rtems/src/ratemongetstatus.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Rate Monotonic Manager -- Get Status<br>+/**<br>+ * @file<br> *<br>
+ * @brief RTEMS Rate Monotonic Get Status<br>+ * @ingroup ClassicRateMon<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2009.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -25,22 +30,6 @@<br> #include <rtems/score/timespec.h><br>
#endif<br> <br>-/*<br>- * rtems_rate_monotonic_get_status<br>- *<br>- * This directive allows a thread to obtain status information on a<br>- * period.<br>- *<br>- * Input parameters:<br>- * id - rate monotonic id<br>
- * status - pointer to status control block<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- *<br>- */<br>-<br> rtems_status_code rtems_rate_monotonic_get_status(<br>
rtems_id id,<br> rtems_rate_monotonic_period_status *status<br>diff --git a/cpukit/rtems/src/ratemonident.c b/cpukit/rtems/src/ratemonident.c<br>index 35e4195..def9580 100644<br>--- a/cpukit/rtems/src/ratemonident.c<br>
+++ b/cpukit/rtems/src/ratemonident.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Rate Monotonic Manager -- Name to Id Lookup<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Rate Monotonic Name to Id<br>+ * @ingroup ClassicRateMon<br>
+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -21,22 +26,6 @@<br> #include <rtems/rtems/ratemon.h><br> #include <rtems/score/thread.h><br>
<br>-/*<br>- * rtems_rate_monotonic_ident<br>- *<br>- * This directive returns the system ID associated with<br>- * the rate monotonic period name.<br>- *<br>- * Input parameters:<br>- * name - user defined period name<br>
- * id - pointer to period 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_rate_monotonic_ident(<br>
rtems_name name,<br> rtems_id *id<br>diff --git a/cpukit/rtems/src/ratemonreportstatistics.c b/cpukit/rtems/src/ratemonreportstatistics.c<br>index c94171c..daf5fb5 100644<br>--- a/cpukit/rtems/src/ratemonreportstatistics.c<br>
+++ b/cpukit/rtems/src/ratemonreportstatistics.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Rate Monotonic Manager -- Report Statistics for All Periods<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Report Rate Monotonic Statistics<br>
+ * @ingroup ClassicRateMon<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2010.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -28,14 +33,6 @@<br> #define NANOSECONDS_FMT "%06" PRId32<br>
#endif<br> <br>-/*<br>- * This directive allows a thread to print the statistics information<br>- * on ALL period instances which have non-zero counts using printk.<br>- *<br>- * The implementation of this directive straddles the fence between<br>
- * inside and outside of RTEMS. It is presented as part of the Manager<br>- * but actually uses other services of the Manager.<br>- */<br> void rtems_rate_monotonic_report_statistics_with_plugin(<br> void *context,<br>
rtems_printk_plugin_t print<br>diff --git a/cpukit/rtems/src/regiongetfreeinfo.c b/cpukit/rtems/src/regiongetfreeinfo.c<br>index 52b7135..bd16b0e 100644<br>--- a/cpukit/rtems/src/regiongetfreeinfo.c<br>+++ b/cpukit/rtems/src/regiongetfreeinfo.c<br>
@@ -1,7 +1,11 @@<br>-/*<br>- * Region Manager<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Get Region Free Information<br>+ * @ingroup ClassicRegion<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br>
*<br>@@ -24,23 +28,6 @@<br> #include <rtems/score/apimutex.h><br> #include <rtems/score/thread.h><br> <br>-/*<br>- * rtems_region_get_free_information<br>- *<br>- * This directive will return information about the free blocks<br>
- * in the region specified. Information about the used blocks<br>- * will be returned as zero.<br>- *<br>- * Input parameters:<br>- * id - region id<br>- * the_info - pointer to region information block<br>
- *<br>- * Output parameters:<br>- * *the_info - region information block filled in<br>- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_region_get_free_information(<br>
rtems_id id,<br> Heap_Information_block *the_info<br>diff --git a/cpukit/rtems/src/rtemsobjectapimaximumclass.c b/cpukit/rtems/src/rtemsobjectapimaximumclass.c<br>index 17ad518..abeee03 100644<br>--- a/cpukit/rtems/src/rtemsobjectapimaximumclass.c<br>
+++ b/cpukit/rtems/src/rtemsobjectapimaximumclass.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * RTEMS Object Helper -- Get Greatest Valid Class for an API<br>+/**<br>+ * @file<br> *<br>+ * @brief Get Highest Valid Class Value<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/rtemsobjectgetapiname.c b/cpukit/rtems/src/rtemsobjectgetapiname.c<br>
index 4976a92..2f10ce7 100644<br>--- a/cpukit/rtems/src/rtemsobjectgetapiname.c<br>+++ b/cpukit/rtems/src/rtemsobjectgetapiname.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * RTEMS Object Helper -- Obtain Name of API<br>+/**<br>+ * @file<br>
*<br>+ * @brief Get API Name<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/semobtain.c b/cpukit/rtems/src/semobtain.c<br>
index 2faaff0..fe5710e 100644<br>--- a/cpukit/rtems/src/semobtain.c<br>+++ b/cpukit/rtems/src/semobtain.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 RTEMS Obtain Semaphore<br>+ * @ingroup ClassicSem<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2008.<br>
* On-Line Applications Research Corporation (OAR).<br> *<br>@@ -47,21 +38,6 @@<br> <br> #include <rtems/score/interr.h><br> <br>-/*<br>- * rtems_semaphore_obtain<br>- *<br>- * This directive allows a thread to acquire a semaphore.<br>
- *<br>- * Input parameters:<br>- * id - semaphore id<br>- * option_set - wait option<br>- * timeout - number of ticks to wait (0 means wait forever)<br>- *<br>- * Output parameters:<br>- * RTEMS_SUCCESSFUL - if successful<br>
- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_semaphore_obtain(<br> rtems_id id,<br> rtems_option option_set,<br>diff --git a/cpukit/rtems/src/taskmode.c b/cpukit/rtems/src/taskmode.c<br>
index 9fab226..63fe29c 100644<br>--- a/cpukit/rtems/src/taskmode.c<br>+++ b/cpukit/rtems/src/taskmode.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * RTEMS Task Manager - Change Task Mode<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Task Mode<br>
+ * @ingroup ClassicTasks<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2010.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -28,22 +33,6 @@<br> #include <rtems/score/apiext.h><br> #include <rtems/score/sysstate.h><br>
<br>-/*<br>- * rtems_task_mode<br>- *<br>- * This directive enables and disables several modes of<br>- * execution for the requesting thread.<br>- *<br>- * Input parameters:<br>- * mode_set - new mode<br>
- * mask - mask<br>- * previous_mode_set - address of previous mode set<br>- *<br>- * Output:<br>- * *previous_mode_set - previous mode set<br>- * always return RTEMS_SUCCESSFUL;<br>- */<br>-<br>
rtems_status_code rtems_task_mode(<br> rtems_mode mode_set,<br> rtems_mode mask,<br>diff --git a/cpukit/rtems/src/taskvariableadd.c b/cpukit/rtems/src/taskvariableadd.c<br>index 415fe69..9a0bc3d 100644<br>--- a/cpukit/rtems/src/taskvariableadd.c<br>
+++ b/cpukit/rtems/src/taskvariableadd.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * rtems_task_variable_add - Add a per-task variable<br>- *<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Add Task Variable<br>+ * @ingroup ClassicTasks<br>
+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -18,12 +22,6 @@<br> #include <rtems/rtems/tasks.h><br> #include <rtems/score/wkspace.h><br>
<br>-/*<br>- * rtems_task_variable_add<br>- *<br>- * This directive registers a task variable.<br>- */<br>-<br> rtems_status_code rtems_task_variable_add(<br> rtems_id tid,<br> void **ptr,<br>diff --git a/cpukit/rtems/src/timerdelete.c b/cpukit/rtems/src/timerdelete.c<br>
index e7a0d15..f259280 100644<br>--- a/cpukit/rtems/src/timerdelete.c<br>+++ b/cpukit/rtems/src/timerdelete.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Timer Manager - rtems_timer_delete directive<br>- *<br>+/**<br>+ * @file<br>
*<br>+ * @brief RTEMS Delete Timer<br>+ * @ingroup ClassicTimer<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2007.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -23,19 +27,6 @@<br> #include <rtems/score/tod.h><br>
#include <rtems/score/watchdog.h><br> <br>-/*<br>- * rtems_timer_delete<br>- *<br>- * This directive allows a thread to delete a timer.<br>- *<br>- * Input parameters:<br>- * id - timer id<br>- *<br>- * Output parameters:<br>
- * RTEMS_SUCCESSFUL - if successful<br>- * error code - if unsuccessful<br>- */<br>-<br> rtems_status_code rtems_timer_delete(<br> rtems_id id<br> )<br>diff --git a/cpukit/rtems/src/timerfireafter.c b/cpukit/rtems/src/timerfireafter.c<br>
index f823a7b..267c1cf 100644<br>--- a/cpukit/rtems/src/timerfireafter.c<br>+++ b/cpukit/rtems/src/timerfireafter.c<br>@@ -1,7 +1,11 @@<br>-/*<br>- * Timer Manager - rtems_timer_fire_after directive<br>- *<br>+/**<br>+ * @file<br>
*<br>+ * @brief RTEMS Timer Fire After<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_after<br>- *<br>- * This directive allows a thread to start a timer.<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_fire_after(<br> rtems_id id,<br> rtems_interval ticks,<br>diff --git a/cpukit/rtems/src/workspace.c b/cpukit/rtems/src/workspace.c<br>
index 7af5897..38747be 100644<br>--- a/cpukit/rtems/src/workspace.c<br>+++ b/cpukit/rtems/src/workspace.c<br>@@ -1,6 +1,11 @@<br>-/*<br>- * Workspace Handler<br>+/**<br>+ * @file<br> *<br>+ * @brief RTEMS Workspace Support<br>
+ * @ingroup ClassicRTEMSWorkspace<br>+ */<br>+<br>+/*<br> * COPYRIGHT (c) 1989-2009.<br> * On-Line Applications Research Corporation (OAR).<br> *<br>@@ -32,9 +37,6 @@ bool rtems_workspace_get_information(<br> return _Protected_heap_Get_information( &_Workspace_Area, the_info );<br>
}<br> <br>-/*<br>- * _Workspace_Allocate<br>- */<br> bool rtems_workspace_allocate(<br> size_t bytes,<br> void **pointer<br>@@ -62,9 +64,6 @@ bool rtems_workspace_allocate(<br> return true;<br> }<br> <br>
-/*<br>- * _Workspace_Allocate<br>- */<br> bool rtems_workspace_free(<br> void *pointer<br> )<br>
</blockquote></div><br></div>