[rtems commit] misc rtems: Clean up Doxygen GCI Task #8
Gedare Bloom
gedare at rtems.org
Sat Dec 8 13:44:43 UTC 2012
Module: rtems
Branch: master
Commit: 4c90eb4a43fbc4380fe4d9deafb4fbcbd13c30d0
Changeset: http://git.rtems.org/rtems/commit/?id=4c90eb4a43fbc4380fe4d9deafb4fbcbd13c30d0
Author: Mathew Kallada <matkallada at gmail.com>
Date: Sat Dec 8 08:48:37 2012 -0500
misc rtems: Clean up Doxygen GCI Task #8
http://www.google-melange.com/gci/task/view/google/gci2012/8024203
---
cpukit/rtems/include/rtems/rtems/barrier.h | 12 ++++++-
cpukit/rtems/include/rtems/rtems/event.h | 19 +++++++----
cpukit/rtems/include/rtems/rtems/eventset.h | 3 ++
cpukit/rtems/include/rtems/rtems/message.h | 20 +++++++-----
cpukit/rtems/include/rtems/rtems/object.h | 2 +
cpukit/rtems/include/rtems/rtems/part.h | 12 ++++---
cpukit/rtems/include/rtems/rtems/ratemon.h | 22 ++++++++-----
cpukit/rtems/include/rtems/rtems/sem.h | 20 +++++++-----
cpukit/rtems/include/rtems/rtems/signal.h | 12 ++++---
cpukit/rtems/include/rtems/rtems/taskmp.h | 4 ++-
cpukit/rtems/include/rtems/rtems/tasks.h | 44 ++++++++++++++------------
cpukit/rtems/include/rtems/rtems/timer.h | 38 +++++++++++++----------
cpukit/rtems/src/barriercreate.c | 9 ++++-
cpukit/rtems/src/barrierdata.c | 9 ++++-
cpukit/rtems/src/barrierrelease.c | 9 ++++-
cpukit/rtems/src/eventreceive.c | 9 ++++-
cpukit/rtems/src/eventseize.c | 9 ++++-
cpukit/rtems/src/msgmp.c | 10 ++++--
cpukit/rtems/src/msgqgetnumberpending.c | 10 ++++--
cpukit/rtems/src/partcreate.c | 10 ++++--
cpukit/rtems/src/ratemoncreate.c | 9 ++++-
cpukit/rtems/src/ratemonresetstatistics.c | 9 ++++-
cpukit/rtems/src/rtemsobjectidgetapi.c | 9 ++++-
cpukit/rtems/src/semrelease.c | 10 +++++-
cpukit/rtems/src/signal.c | 10 ++++--
cpukit/rtems/src/taskmp.c | 10 ++++--
cpukit/rtems/src/taskstart.c | 10 ++++--
cpukit/rtems/src/taskvariableget.c | 10 ++++--
cpukit/rtems/src/timerreset.c | 10 ++++--
cpukit/rtems/src/timerserverfirewhen.c | 10 ++++--
30 files changed, 251 insertions(+), 129 deletions(-)
diff --git a/cpukit/rtems/include/rtems/rtems/barrier.h b/cpukit/rtems/include/rtems/rtems/barrier.h
index 4884d2c..340c6a1 100644
--- a/cpukit/rtems/include/rtems/rtems/barrier.h
+++ b/cpukit/rtems/include/rtems/rtems/barrier.h
@@ -34,6 +34,10 @@
/**@{*/
/**
+ * @brief Instantiate Barrier Data
+ *
+ * Barrier 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
@@ -80,7 +84,9 @@ RTEMS_BARRIER_EXTERN Objects_Information _Barrier_Information;
void _Barrier_Manager_initialization(void);
/**
- * @brief rtems_barrier_create
+ * @brief RTEMS Create Barrier
+ *
+ * Barrier Manager -- Create a Barrier Instance
*
* This routine implements the rtems_barrier_create directive. The
* barrier will have the name name. The starting count for
@@ -160,7 +166,9 @@ rtems_status_code rtems_barrier_wait(
);
/**
- * @brief rtems_barrier_release
+ * @brief RTEMS Barrier Release
+ *
+ * Barrier Manager -- Release Tasks Waitng at a Barrier
*
* This routine implements the rtems_barrier_release directive. It
* unblocks all of the threads waiting on the barrier associated with
diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index b3762b2..c099f9b 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/cpukit/rtems/include/rtems/rtems/event.h
@@ -70,7 +70,7 @@ extern "C" {
* - Events do not hold or transport data.
* - Events are not queued. In other words, if an event is sent more than once
* to a task before being received, the second and subsequent send
- * operations to that same task have no effect.
+ * operations to that same task have no effect.
*
* An event set is posted when it is directed (or sent) to a task. A pending
* event is an event that has been posted but not received. An event condition
@@ -80,7 +80,7 @@ extern "C" {
* selected by the user. The @ref RTEMS_EVENT_ANY algorithm states that an
* event condition is satisfied when at least a single requested event is
* posted. The @ref RTEMS_EVENT_ALL algorithm states that an event condition
- * is satisfied when every requested event is posted.
+ * is satisfied when every requested event is posted.
*
* An event set or condition is built by a bitwise or of the desired events.
* The set of valid events is @ref RTEMS_EVENT_0 through @ref RTEMS_EVENT_31.
@@ -92,7 +92,7 @@ extern "C" {
* For example, when sending the event set consisting of @ref RTEMS_EVENT_6,
* @ref RTEMS_EVENT_15, and @ref RTEMS_EVENT_31, the event parameter to the
* rtems_event_send() directive should be @ref RTEMS_EVENT_6 |
- * @ref RTEMS_EVENT_15 | @ref RTEMS_EVENT_31.
+ * @ref RTEMS_EVENT_15 | @ref RTEMS_EVENT_31.
*
* @{
*/
@@ -109,9 +109,9 @@ extern "C" {
* If the waiting task's input event condition is
* - satisfied, then the task is made ready for execution.
* - not satisfied, then the event set is posted but left pending and the
- * task remains blocked.
+ * task remains blocked.
* - not waiting for events.
- * - The event set is posted and left pending.
+ * - The event set is posted and left pending.
*
* Identical events sent to a task are not queued. In other words, the second,
* and subsequent, posting of an event to a task before it can perform an
@@ -190,7 +190,7 @@ rtems_status_code rtems_event_send (
* @param[in] ticks Time out in ticks. Use @ref RTEMS_NO_TIMEOUT to wait
* without a time out (potentially forever).
* @param[out] event_out Set of received events (output events).
- *
+ *
* @retval RTEMS_SUCCESSFUL Successful operation.
* @retval RTEMS_UNSATISFIED Input events not satisfied (only with the
* @ref RTEMS_NO_WAIT option).
@@ -438,7 +438,12 @@ typedef struct {
/**
* @brief Event Manager Initialization
*
+ * Event Manager
+ *
* This routine performs the initialization necessary for this manager.
+ *
+ * - INTERRUPT LATENCY:
+ * + single case
*/
void _Event_Manager_initialization( void );
@@ -455,7 +460,7 @@ void _Event_Seize(
/**
* @brief Surrender Event
- *
+ *
* - INTERRUPT LATENCY:
* + before flash
* + after flash
diff --git a/cpukit/rtems/include/rtems/rtems/eventset.h b/cpukit/rtems/include/rtems/rtems/eventset.h
index d543ba5..10b498b 100644
--- a/cpukit/rtems/include/rtems/rtems/eventset.h
+++ b/cpukit/rtems/include/rtems/rtems/eventset.h
@@ -109,6 +109,9 @@ typedef uint32_t rtems_event_set;
/**
* @brief Constant used to receive the set of currently pending events in
+ *
+ * Event Manager
+ *
* rtems_event_receive().
*
* @ingroup ClassicEvent
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index 8c376c5..4f44f73 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/cpukit/rtems/include/rtems/rtems/message.h
@@ -112,13 +112,13 @@ void _Message_queue_Manager_initialization(void);
* that can be outstanding, then @a count indicates the maximum number of
* messages that will be held. It returns the id of the created
* message queue in @a id.
- *
+ *
* @param[in] name is the user defined queue name
* @param[in] count is the maximum message and reserved buffer count
* @param[in] max_message_size is the maximum size of each message
* @param[in] attribute_set is the process method
* @param[in] id is the pointer to queue
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the @a id will
@@ -244,14 +244,14 @@ rtems_status_code rtems_message_queue_broadcast(
* message is to be placed in buffer. If no messages are outstanding
* and the option_set indicates that the task is willing to block,
* then the task will be blocked until a message arrives or until,
- * optionally, timeout clock ticks have passed.
- *
+ * optionally, timeout clock ticks have passed.
+ *
* @param[in] id is the queue id
* @param[in] buffer is the pointer to message buffer
* @param[in] size is the size of message receive
* @param[in] option_set is the options on receive
* @param[in] timeout is the number of ticks to wait
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -280,7 +280,9 @@ rtems_status_code rtems_message_queue_flush(
);
/**
- * @brief rtems_message_queue_get_number_pending
+ * @brief RTEMS Message Queue Get Number Pending
+ *
+ * Message Queue Manager
*
* This routine implements the rtems_message_queue_get_number_pending
* directive. This directive returns the number of pending
@@ -315,7 +317,7 @@ rtems_status_code _Message_queue_Submit(
*
* This function allocates a message queue control block from
* the inactive chain of free message queue control blocks.
- *
+ *
* @return the_message_queue filled in if successful, NULL otherwise
*/
Message_queue_Control *_Message_queue_Allocate (void);
@@ -325,9 +327,9 @@ Message_queue_Control *_Message_queue_Allocate (void);
*
* This function returns a RTEMS status code based on
* @a the_message_queue_status.
- *
+ *
* @param[in] the_message_queue_status is the status code to translate
- *
+ *
* @return translated RTEMS status code
*/
rtems_status_code _Message_queue_Translate_core_message_queue_return_code (
diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h
index c59f1c9..7baa80c 100644
--- a/cpukit/rtems/include/rtems/rtems/object.h
+++ b/cpukit/rtems/include/rtems/rtems/object.h
@@ -154,6 +154,8 @@ rtems_status_code rtems_object_set_name(
/**
* @brief Get API Portion of Object Id
*
+ * RTEMS Object Helper -- Extract API From Id
+ *
* This function returns the API portion of the Id.
*
* @param[in] _id is the Id of the object to obtain the API from
diff --git a/cpukit/rtems/include/rtems/rtems/part.h b/cpukit/rtems/include/rtems/rtems/part.h
index ced0b05..e62e904 100644
--- a/cpukit/rtems/include/rtems/rtems/part.h
+++ b/cpukit/rtems/include/rtems/rtems/part.h
@@ -93,7 +93,9 @@ RTEMS_PART_EXTERN Objects_Information _Partition_Information;
void _Partition_Manager_initialization(void);
/**
- * @brief rtems_partition_create
+ * @brief RTEMS Partition Create
+ *
+ * Partition Manager
*
* This routine implements the rtems_partition_create directive. The
* partition will have the name name. The memory area managed by
@@ -142,9 +144,9 @@ rtems_status_code rtems_partition_ident(
* This routine implements the rtems_partition_delete directive. The
* partition indicated by ID is deleted, provided that none of its buffers
* are still allocated.
- *
+ *
* @param[in] id is the partition id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -159,10 +161,10 @@ rtems_status_code rtems_partition_delete(
* This routine implements the rtems_partition_get_buffer directive. It
* attempts to allocate a buffer from the partition associated with ID.
* If a buffer is allocated, its address is returned in buffer.
- *
+ *
* @param[in] id is the partition id
* @param[out] buffer is the pointer to buffer address
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_partition_get_buffer(
diff --git a/cpukit/rtems/include/rtems/rtems/ratemon.h b/cpukit/rtems/include/rtems/rtems/ratemon.h
index 799ebbe..475a90a 100644
--- a/cpukit/rtems/include/rtems/rtems/ratemon.h
+++ b/cpukit/rtems/include/rtems/rtems/ratemon.h
@@ -271,13 +271,15 @@ RTEMS_RATEMON_EXTERN Objects_Information _Rate_monotonic_Information;
* @brief Rate Monotonic Manager Initialization
*
* This routine performs the initialization necessary for this manager.
- *
+ *
* @note The Rate Monotonic Manager is built on top of the Watchdog Handler
*/
void _Rate_monotonic_Manager_initialization(void);
/**
- * @brief rtems_rate_monotonic_create
+ * @brief Create a Period
+ *
+ * Rate Monotonic Manager
*
* This routine implements the rate_monotonic_create directive. The
* period will have the name name. It returns the id of the
@@ -294,10 +296,10 @@ rtems_status_code rtems_rate_monotonic_create(
* This routine implements the rtems_rate_monotonic_ident directive.
* It returns the period ID associated with name. If more than one period
* is named name, then the period to which the ID belongs is arbitrary.
- *
+ *
* @param[in] name is the user defined period name
* @param[in] id is the pointer to period id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the id will
@@ -330,9 +332,9 @@ rtems_status_code rtems_rate_monotonic_cancel(
*
* This routine implements the rtems_rate_monotonic_delete directive. The
* period indicated by ID is deleted.
- *
+ *
* @param[in] id is the rate monotonic id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -346,10 +348,10 @@ rtems_status_code rtems_rate_monotonic_delete(
*
* This routine implements the rtems_rate_monotonic_get_status directive.
* Information about the period indicated by ID is returned.
- *
+ *
* @param[in] id is the rate monotonic id
* @param[in] status is the pointer to status control block
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -377,7 +379,9 @@ rtems_status_code rtems_rate_monotonic_get_statistics(
);
/**
- * @brief rtems_rate_monotonic_reset_statistics
+ * @brief RTEMS Rate Monotonic Reset Statistics
+ *
+ * Rate Monotonic Manager -- Reset Statistics
*
* This routine allows a thread to reset the statistics information
* on a specific period instance.
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index 9848740..ea0aea3 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -163,9 +163,9 @@ rtems_status_code rtems_semaphore_ident(
*
* This routine implements the rtems_semaphore_delete directive. The
* semaphore indicated by ID is deleted.
- *
+ *
* @param[in] id is the semaphore id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -184,11 +184,11 @@ rtems_status_code rtems_semaphore_delete(
* block waiting for a unit with an optional timeout of timeout
* clock ticks. Whether the task blocks or returns immediately
* is based on the RTEMS_NO_WAIT option in the option_set.
- *
+ *
* @param[in] id is the semaphore id
* @param[in] option_set is the wait option
* @param[in] timeout is the number of ticks to wait (0 means wait forever)
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -200,7 +200,9 @@ rtems_status_code rtems_semaphore_obtain(
);
/**
- * @brief rtems_semaphore_release
+ * @brief RTEMS Semaphore Release
+ *
+ * Semaphore Manager
*
* This routine implements the rtems_semaphore_release directive. It
* frees a unit to the semaphore associated with ID. If a task was
@@ -248,9 +250,9 @@ bool _Semaphore_Seize(
*
* This function returns a RTEMS status code based on the mutex
* status code specified.
- *
+ *
* @param[in] the_mutex_status is the mutex status code to translate
- *
+ *
* @return translated RTEMS status code
*/
rtems_status_code _Semaphore_Translate_core_mutex_return_code (
@@ -262,9 +264,9 @@ rtems_status_code _Semaphore_Translate_core_mutex_return_code (
*
* This function returns a RTEMS status code based on the semaphore
* status code specified.
- *
+ *
* @param[in] status is the semaphore status code to translate
- *
+ *
* @return translated RTEMS status code
*/
rtems_status_code _Semaphore_Translate_core_semaphore_return_code (
diff --git a/cpukit/rtems/include/rtems/rtems/signal.h b/cpukit/rtems/include/rtems/rtems/signal.h
index 54359cc..6e24254 100644
--- a/cpukit/rtems/include/rtems/rtems/signal.h
+++ b/cpukit/rtems/include/rtems/rtems/signal.h
@@ -41,7 +41,9 @@
extern "C" {
#endif
/**
- * @brief _Signal_Manager_initialization
+ * @brief Signal Manager Initialization
+ *
+ * Signal Manager
*
* This routine performs the initialization necessary for this manager.
*/
@@ -54,11 +56,11 @@ void _Signal_Manager_initialization( void );
* is used to establish asr_handler as the Asynchronous Signal Routine
* (RTEMS_ASR) for the calling task. The asr_handler will execute with a
* mode of mode_set.
- *
+ *
* @param[in] asr_handler is the address of asynchronous signal routine (asr)
* ( NULL indicates asr is invalid )
* @param[in] mode_set is the mode value for asr
- *
+ *
* @return RTEMS_SUCCESSFUL
*/
rtems_status_code rtems_signal_catch(
@@ -71,10 +73,10 @@ rtems_status_code rtems_signal_catch(
*
* This routine implements the rtems_signal_send directive. This directive
* sends the signal_set to the task specified by ID.
- *
+ *
* @param[in] id is the thread thread id
* @param[in] signal_set is the signal set
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_signal_send(
diff --git a/cpukit/rtems/include/rtems/rtems/taskmp.h b/cpukit/rtems/include/rtems/rtems/taskmp.h
index 28fa73d..7bf4c1b 100644
--- a/cpukit/rtems/include/rtems/rtems/taskmp.h
+++ b/cpukit/rtems/include/rtems/rtems/taskmp.h
@@ -68,7 +68,9 @@ typedef struct {
} RTEMS_tasks_MP_Packet;
/**
- * @brief _RTEMS_tasks_MP_Send_process_packet
+ * @brief RTEMS Tasks MP Send Process Packet
+ *
+ * Multiprocessing Support for the RTEMS Task 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/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index d3b34c4..607f87c 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -45,7 +45,7 @@
/**
* @brief Instantiate RTEMS Classic API Tasks Data
- *
+ *
* This constant is defined to extern most of the time when using
* this header file. However by defining it to nothing, the data
* declared in this header file can be instantiated. This is done
@@ -287,11 +287,11 @@ rtems_status_code rtems_task_create(
* extent of the search for the ID of the task named name.
* The search can be limited to a particular node or allowed to
* encompass all nodes.
- *
+ *
* @param[in] name is the user defined thread name
* @param[in] node is(are) the node(s) to be searched
* @param[in] id is the pointer to thread id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error. If successful, the id will
@@ -309,9 +309,9 @@ rtems_status_code rtems_task_ident(
* This routine implements the rtems_task_delete directive. The
* task indicated by ID is deleted. The executive halts execution
* of the thread and frees the thread control block.
- *
+ *
* @param[in] id is the thread id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error and id is not the requesting thread. Status code is
* returned indicating the source of the error. Nothing
@@ -327,11 +327,11 @@ rtems_status_code rtems_task_delete(
* This routine implements the rtems_task_get_note directive. The
* value of the indicated notepad for the task associated with ID
* is returned in note.
- *
+ *
* @param[in] id is the thread id
* @param[in] notepad is the notepad number
* @param[out] note is the pointer to note
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_task_get_note(
@@ -346,11 +346,11 @@ rtems_status_code rtems_task_get_note(
* This routine implements the rtems_task_set_note directive. The
* value of the indicated notepad for the task associated with ID
* is returned in note.
- *
+ *
* @param[in] id is the thread id
* @param[in] notepad is the notepad number
* @param[in] note is the note value
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -368,12 +368,12 @@ rtems_status_code rtems_task_set_note(
* values of the modes indicated by mask of the calling task are changed
* to that indicated in mode_set. The former mode of the task is
* returned in mode_set.
- *
+ *
* @param[in] mode_set is the new mode
* @param[in] mask is the mask
* @param[in] previous_mode_set is the address of previous mode set
- *
- * @return RTEMS_SUCCESSFUL and previous_mode_set filled in with the
+ *
+ * @return RTEMS_SUCCESSFUL and previous_mode_set filled in with the
* previous mode set
*/
rtems_status_code rtems_task_mode(
@@ -388,10 +388,10 @@ rtems_status_code rtems_task_mode(
* This routine implements the rtems_task_restart directive. The
* task associated with ID is restarted at its initial entry
* point with the new argument.
- *
+ *
* @param[in] id is the thread id
* @param[in] arg is the thread argument
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_task_restart(
@@ -405,9 +405,9 @@ rtems_status_code rtems_task_restart(
* This routine implements the rtems_task_suspend directive. The
* SUSPENDED state is set for task associated with ID. Note that the
* suspended state can be in addition to other waiting states.
- *
+ *
* @param[in] id is the thread id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -421,9 +421,9 @@ rtems_status_code rtems_task_suspend(
*
* This routine implements the rtems_task_resume Directive. The
* SUSPENDED state is cleared for task associated with ID.
- *
+ *
* @param[in] id is the thread id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -454,7 +454,9 @@ rtems_status_code rtems_task_set_priority(
);
/**
- * @brief rtems_task_start
+ * @brief RTEMS Start Task
+ *
+ * RTEMS Task Manager
*
* This routine implements the rtems_task_start directive. The
* starting execution point of the task associated with ID is
@@ -519,7 +521,9 @@ rtems_status_code rtems_task_variable_add(
);
/**
- * @brief rtems_task_variable_get
+ * @brief Get a per-task variable
+ *
+ * RTEMS Task Variable Get
*
* This directive gets the value of a task variable.
*/
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index 5a908eb..d8c7760 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -38,7 +38,7 @@
/**
* @brief Instantiate RTEMS Timer 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
@@ -234,10 +234,10 @@ void _Timer_Manager_initialization(void);
* This routine implements the rtems_timer_create directive. The
* timer will have the name name. It returns the id of the
* created timer in ID.
- *
+ *
* @param[in] name is the timer name
* @param[out] id is the pointer to timer id
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful
*/
rtems_status_code rtems_timer_create(
@@ -252,10 +252,10 @@ rtems_status_code rtems_timer_create(
* This directive returns the timer ID associated with name.
* If more than one timer is named name, then the timer
* to which the ID belongs is arbitrary.
- *
+ *
* @param[in] name is the user defined message queue name
* @param[in] id is the pointer to timer id
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* id filled with the message queue id
*/
@@ -279,9 +279,9 @@ rtems_status_code rtems_timer_cancel(
*
* This routine implements the rtems_timer_delete directive. The
* timer indicated by ID is deleted.
- *
+ *
* @param[in] id is the timer id
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -298,12 +298,12 @@ rtems_status_code rtems_timer_delete(
* When the timer fires, the routine will be invoked in the context
* of the rtems_clock_tick directive which is normally invoked as
* part of servicing a periodic interupt.
- *
+ *
* @param[in] id is the timer id
* @param[in] ticks is the interval until routine is fired
* @param[in] routine is the routine to schedule
* @param[in] user_data is the passed as argument to routine when it is fired
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -323,12 +323,12 @@ rtems_status_code rtems_timer_fire_after(
* ticks. When the timer fires, the routine will be invoked by the
* Timer Server in the context of a task NOT IN THE CONTEXT of the
* clock tick interrupt.
- *
+ *
* @param[in] id is the timer id
* @param[in] ticks is the interval until routine is fired
* @param[in] routine is the routine to schedule
* @param[in] user_data is the passed as argument to routine when it is fired
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -348,12 +348,12 @@ rtems_status_code rtems_timer_server_fire_after(
* When the timer fires, the routine will be invoked in the context
* of the rtems_clock_tick directive which is normally invoked as
* part of servicing a periodic interupt.
- *
+ *
* @param[in] id is the timer id
* @param[in] wall_time is the time of day to fire timer
* @param[in] routine is the routine to schedule
* @param[in] user_data is the passed as argument to routine when it is fired
- *
+ *
* @return This method returns RTEMS_SUCCESSFUL if there was not an
* error. Otherwise, a status code is returned indicating the
* source of the error.
@@ -366,7 +366,9 @@ rtems_status_code rtems_timer_fire_when(
);
/**
- * @brief rtems_timer_server_fire_when
+ * @brief RTEMS Timer Server Fire When Directive
+ *
+ * Timer Manager - RTEMS Timer Server Fire When Directive
*
* This routine implements the rtems_timer_server_fire_when directive. It
* initiates the timer associated with ID to fire at wall_time
@@ -382,7 +384,9 @@ rtems_status_code rtems_timer_server_fire_when(
);
/**
- * @brief rtems_timer_reset
+ * @brief RTEMS Timer Reset
+ *
+ * Timer Manager - RTEMS Timer Reset
*
* This routine implements the rtems_timer_reset directive. It is used
* to reinitialize the interval timer associated with ID just as if
@@ -433,10 +437,10 @@ typedef struct {
*
* This routine implements the rtems_timer_get_information directive.
* This directive returns information about the timer.
- *
+ *
* @param[in] id is the timer id
* @param[in] the_info is the pointer to timer information block
- *
+ *
* @return RTEMS_SUCCESSFUL if successful or error code if unsuccessful and
* *the_info region information block filled in
*/
diff --git a/cpukit/rtems/src/barriercreate.c b/cpukit/rtems/src/barriercreate.c
index 80d616f..b245014 100644
--- a/cpukit/rtems/src/barriercreate.c
+++ b/cpukit/rtems/src/barriercreate.c
@@ -1,6 +1,11 @@
-/*
- * Barrier Manager -- Create a Barrier Instance
+/**
+ * @file
*
+ * @brief RTEMS Create Barrier
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
* COPYRIGHT (c) 1989-2006.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/barrierdata.c b/cpukit/rtems/src/barrierdata.c
index f9e03fb..6481dbc 100644
--- a/cpukit/rtems/src/barrierdata.c
+++ b/cpukit/rtems/src/barrierdata.c
@@ -1,6 +1,11 @@
-/*
- * Barrier Manager -- Instantiate Data
+/**
+ * @file
*
+ * @brief Instantiate Barrier Data
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/barrierrelease.c b/cpukit/rtems/src/barrierrelease.c
index 2393d66..550d82a 100644
--- a/cpukit/rtems/src/barrierrelease.c
+++ b/cpukit/rtems/src/barrierrelease.c
@@ -1,6 +1,11 @@
-/*
- * Barrier Manager -- Release Tasks Waitng at a Barrier
+/**
+ * @file
*
+ * @brief RTEMS Barrier Release
+ * @ingroup ClassicBarrier Barriers
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/eventreceive.c b/cpukit/rtems/src/eventreceive.c
index 0361d2c..a6e32ba 100644
--- a/cpukit/rtems/src/eventreceive.c
+++ b/cpukit/rtems/src/eventreceive.c
@@ -1,6 +1,11 @@
-/*
- * Event Manager
+/**
+ * @file
*
+ * @brief Constant used to receive the set of currently pending events in
+ * @ingroup ClassicEventSet Event Set
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/eventseize.c b/cpukit/rtems/src/eventseize.c
index c88f3f7..4cb1f80 100644
--- a/cpukit/rtems/src/eventseize.c
+++ b/cpukit/rtems/src/eventseize.c
@@ -1,6 +1,11 @@
-/*
- * Event Manager
+/**
+ * @file
*
+ * @brief Event Manager Initialization
+ * @ingroup ClassicEvent Events
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/msgmp.c b/cpukit/rtems/src/msgmp.c
index 666fad2..39f8247 100644
--- a/cpukit/rtems/src/msgmp.c
+++ b/cpukit/rtems/src/msgmp.c
@@ -1,7 +1,11 @@
-/*
- * Multiprocessing Support for the Message Queue Manager
- *
+/**
+ * @file
*
+ * @brief Multiprocessing Support for the Message Queue Manager
+ * @ingroup ClassicMsgMP Message Queue MP Support
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/msgqgetnumberpending.c b/cpukit/rtems/src/msgqgetnumberpending.c
index 9941317..0139144 100644
--- a/cpukit/rtems/src/msgqgetnumberpending.c
+++ b/cpukit/rtems/src/msgqgetnumberpending.c
@@ -1,7 +1,11 @@
-/*
- * Message Queue Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Message Queue Get Number Pending
+ * @ingroup ClassicMessageQueue Message Queues
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/partcreate.c b/cpukit/rtems/src/partcreate.c
index ae1ec70..536f56e 100644
--- a/cpukit/rtems/src/partcreate.c
+++ b/cpukit/rtems/src/partcreate.c
@@ -1,7 +1,11 @@
-/*
- * Partition Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Partition Create
+ * @ingroup ClassicPart Partitions
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/ratemoncreate.c b/cpukit/rtems/src/ratemoncreate.c
index 80627f2..2e5e975 100644
--- a/cpukit/rtems/src/ratemoncreate.c
+++ b/cpukit/rtems/src/ratemoncreate.c
@@ -1,6 +1,11 @@
-/*
- * Rate Monotonic Manager -- Create a Period
+/**
+ * @file
*
+ * @brief Create a Period
+ * @ingroup ClassicRateMon Rate Monotonic Scheduler
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/ratemonresetstatistics.c b/cpukit/rtems/src/ratemonresetstatistics.c
index 7a38fee..a9d3934 100644
--- a/cpukit/rtems/src/ratemonresetstatistics.c
+++ b/cpukit/rtems/src/ratemonresetstatistics.c
@@ -1,6 +1,11 @@
-/*
- * Rate Monotonic Manager -- Reset Statistics
+/**
+ * @file
*
+ * @brief RTEMS Rate Monotonic Reset Statistics
+ * @ingroup ClassicRateMon Rate Monotonic Scheduler
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/rtemsobjectidgetapi.c b/cpukit/rtems/src/rtemsobjectidgetapi.c
index 88bf30b..bce0eaa 100644
--- a/cpukit/rtems/src/rtemsobjectidgetapi.c
+++ b/cpukit/rtems/src/rtemsobjectidgetapi.c
@@ -1,6 +1,11 @@
-/*
- * RTEMS Object Helper -- Extract API From Id
+/**
+ * @file
*
+ * @brief Get API Portion of Object Id
+ * @ingroup ClassicClassInfo Object Class Information
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/semrelease.c b/cpukit/rtems/src/semrelease.c
index dea8f0b..6600966 100644
--- a/cpukit/rtems/src/semrelease.c
+++ b/cpukit/rtems/src/semrelease.c
@@ -1,5 +1,8 @@
-/*
- * Semaphore Manager
+/**
+ * @file
+ *
+ * @brief RTEMS Semaphore Release
+ * @ingroup ClassicSem Semaphores
*
* DESCRIPTION:
*
@@ -15,6 +18,9 @@
* + acquire a semaphore
* + release a semaphore
*
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/signal.c b/cpukit/rtems/src/signal.c
index 9528490..13e04d3 100644
--- a/cpukit/rtems/src/signal.c
+++ b/cpukit/rtems/src/signal.c
@@ -1,7 +1,11 @@
-/*
- * Signal Manager
- *
+/**
+ * @file
*
+ * @brief Signal Manager Initialization
+ * @ingroup ClassicSignal Signals
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/taskmp.c b/cpukit/rtems/src/taskmp.c
index ead2513..c48d9c7 100644
--- a/cpukit/rtems/src/taskmp.c
+++ b/cpukit/rtems/src/taskmp.c
@@ -1,7 +1,11 @@
-/*
- * Multiprocessing Support for the RTEMS Task Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Tasks MP Send Process Packet
+ * @ingroup ClassicTaskMP Task MP Support
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/taskstart.c b/cpukit/rtems/src/taskstart.c
index c6f1078..4a168bf 100644
--- a/cpukit/rtems/src/taskstart.c
+++ b/cpukit/rtems/src/taskstart.c
@@ -1,7 +1,11 @@
-/*
- * RTEMS Task Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Start Task
+ * @ingroup ClassicTasks Tasks
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/taskvariableget.c b/cpukit/rtems/src/taskvariableget.c
index 8801a24..d2074b2 100644
--- a/cpukit/rtems/src/taskvariableget.c
+++ b/cpukit/rtems/src/taskvariableget.c
@@ -1,7 +1,11 @@
-/*
- * rtems_task_variable_get - Get a per-task variable
- *
+/**
+ * @file
*
+ * @brief Get a per-task variable
+ * @ingroup ClassicTasks Tasks
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/timerreset.c b/cpukit/rtems/src/timerreset.c
index e86957c..0e80521 100644
--- a/cpukit/rtems/src/timerreset.c
+++ b/cpukit/rtems/src/timerreset.c
@@ -1,7 +1,11 @@
-/*
- * Timer Manager - rtems_timer_reset directive
- *
+/**
+ * @file
*
+ * @brief RTEMS Timer Reset
+ * @ingroup ClassicTimer Timers
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/timerserverfirewhen.c b/cpukit/rtems/src/timerserverfirewhen.c
index 5f029a0..11a1e15 100644
--- a/cpukit/rtems/src/timerserverfirewhen.c
+++ b/cpukit/rtems/src/timerserverfirewhen.c
@@ -1,7 +1,11 @@
-/*
- * Timer Manager - rtems_timer_server fire_when directive
- *
+/**
+ * @file
*
+ * @brief RTEMS Timer Server Fire When Directive
+ * @ingroup ClassicTimer Timers
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
More information about the vc
mailing list