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