summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/src
diff options
context:
space:
mode:
authorAlex Ivanov <alexivanov97@gmail.com>2012-12-02 10:03:09 -0600
committerJoel Sherrill <joel.sherrill@oarcorp.com>2012-12-02 10:03:09 -0600
commit52adc808422cf415027c07c54910086227bcb973 (patch)
tree74d6da54a3d4ca2cc9f41dd93bf482f9c44a77ef /cpukit/rtems/src
parentscore misc: Score misc: Clean up Doxygen #11 (GCI 2012) (diff)
downloadrtems-52adc808422cf415027c07c54910086227bcb973.tar.bz2
score misc: Clean up Doxygen #12 (GCI 2012)
This patch is a task from GCI 2012 which improves the Doxygen comments in the RTEMS source. http://www.google-melange.com/gci/task/view/google/gci2012/8025203
Diffstat (limited to 'cpukit/rtems/src')
-rw-r--r--cpukit/rtems/src/clockgetsecondssinceepoch.c9
-rw-r--r--cpukit/rtems/src/clockgettickspersecond.c9
-rw-r--r--cpukit/rtems/src/event.c17
-rw-r--r--cpukit/rtems/src/intrbody.c26
-rw-r--r--cpukit/rtems/src/intrcatch.c25
-rw-r--r--cpukit/rtems/src/msgqbroadcast.c28
-rw-r--r--cpukit/rtems/src/msgqurgent.c25
-rw-r--r--cpukit/rtems/src/partident.c27
-rw-r--r--cpukit/rtems/src/ratemondata.c9
-rw-r--r--cpukit/rtems/src/ratemontimeout.c23
-rw-r--r--cpukit/rtems/src/regionresizesegment.c26
-rw-r--r--cpukit/rtems/src/rtemsobjectgetname.c14
-rw-r--r--cpukit/rtems/src/semflush.c28
-rw-r--r--cpukit/rtems/src/semmp.c67
-rw-r--r--cpukit/rtems/src/taskcreate.c31
-rw-r--r--cpukit/rtems/src/tasks.c30
-rw-r--r--cpukit/rtems/src/taskvariabledelete.c16
-rw-r--r--cpukit/rtems/src/taskwakeafter.c23
-rw-r--r--cpukit/rtems/src/taskwakewhen.c24
-rw-r--r--cpukit/rtems/src/timergetinfo.c26
20 files changed, 140 insertions, 343 deletions
diff --git a/cpukit/rtems/src/clockgetsecondssinceepoch.c b/cpukit/rtems/src/clockgetsecondssinceepoch.c
index 91ca553421..c1f2af5374 100644
--- a/cpukit/rtems/src/clockgetsecondssinceepoch.c
+++ b/cpukit/rtems/src/clockgetsecondssinceepoch.c
@@ -1,6 +1,11 @@
-/*
- * Clock Manager - Get Seconds Since Epoch
+/**
+ * @file
*
+ * @brief Obtain Seconds Since Epoch
+ * @ingroup ClassicClock
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/clockgettickspersecond.c b/cpukit/rtems/src/clockgettickspersecond.c
index 8d2be165e4..3a6d2808f3 100644
--- a/cpukit/rtems/src/clockgettickspersecond.c
+++ b/cpukit/rtems/src/clockgettickspersecond.c
@@ -1,6 +1,11 @@
-/*
- * Clock Manager - Get Ticks Per Second
+/**
+ * @file
*
+ * @brief Obtain Ticks Per Seconds
+ * @ingroup ClassicClock
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/event.c b/cpukit/rtems/src/event.c
index d5c29f6a3e..9be4946ce8 100644
--- a/cpukit/rtems/src/event.c
+++ b/cpukit/rtems/src/event.c
@@ -1,6 +1,11 @@
-/*
- * Event Manager
+/**
+ * @file
*
+ * @brief Event Manager Initialization
+ * @ingroup ClassicEvent
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,14 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/rtems/tasks.h>
-/*
- * _Event_Manager_initialization
- *
- * DESCRIPTION:
- *
- * This routine performs the initialization necessary for this manager.
- */
-
void _Event_Manager_initialization( void )
{
_Event_Sync_state = THREAD_BLOCKING_OPERATION_SYNCHRONIZED;
diff --git a/cpukit/rtems/src/intrbody.c b/cpukit/rtems/src/intrbody.c
index 780b59836c..237a0a3a78 100644
--- a/cpukit/rtems/src/intrbody.c
+++ b/cpukit/rtems/src/intrbody.c
@@ -1,7 +1,11 @@
-/*
- * Bodies for Inlined Interrupt Manager Routines
- *
+/**
+ * @file
*
+ * @brief RTEMS Interrupt Support
+ * @ingroup ClassicINTR
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -19,10 +23,6 @@
#include <rtems/score/isr.h>
#include <rtems/rtems/intr.h>
-/*
- * Real body for rtems_interrupt_disable
- */
-
#undef rtems_interrupt_disable
rtems_interrupt_level rtems_interrupt_disable( void )
@@ -34,10 +34,6 @@ rtems_interrupt_level rtems_interrupt_disable( void )
return previous_level;
}
-/*
- * Real body for rtems_interrupt_enable
- */
-
#undef rtems_interrupt_enable
void rtems_interrupt_enable(
@@ -47,10 +43,6 @@ void rtems_interrupt_enable(
_ISR_Enable( previous_level );
}
-/*
- * Real body for rtems_interrupt_flash
- */
-
#undef rtems_interrupt_flash
void rtems_interrupt_flash(
@@ -60,10 +52,6 @@ void rtems_interrupt_flash(
_ISR_Flash( previous_level );
}
-/*
- * Real body for rtems_interrupt_is_in_progress
- */
-
#undef rtems_interrupt_is_in_progress
bool rtems_interrupt_is_in_progress( void )
diff --git a/cpukit/rtems/src/intrcatch.c b/cpukit/rtems/src/intrcatch.c
index b752374c98..0326a187f1 100644
--- a/cpukit/rtems/src/intrcatch.c
+++ b/cpukit/rtems/src/intrcatch.c
@@ -1,7 +1,11 @@
-/*
- * Interrupt Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Interrupt Catch
+ * @ingroup ClassicINTR
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,21 +25,6 @@
#if (CPU_SIMPLE_VECTORED_INTERRUPTS == TRUE)
-/* rtems_interrupt_catch
- *
- * This directive allows a thread to specify what action to take when
- * catching signals.
- *
- * Input parameters:
- * new_isr_handler - address of interrupt service routine (isr)
- * vector - interrupt vector number
- * old_isr_handler - address at which to store previous ISR address
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - always succeeds
- * *old_isr_handler - previous ISR address
- */
-
rtems_status_code rtems_interrupt_catch(
rtems_isr_entry new_isr_handler,
rtems_vector_number vector,
diff --git a/cpukit/rtems/src/msgqbroadcast.c b/cpukit/rtems/src/msgqbroadcast.c
index 9460613a76..a1c2a9f417 100644
--- a/cpukit/rtems/src/msgqbroadcast.c
+++ b/cpukit/rtems/src/msgqbroadcast.c
@@ -1,7 +1,11 @@
-/*
- * Message Queue Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Broadcast Message Queue
+ * @ingroup ClassicMessageQueue
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -32,24 +36,6 @@
#include <rtems/rtems/options.h>
#include <rtems/rtems/support.h>
-/*
- * rtems_message_queue_broadcast
- *
- * This directive sends a message for every thread waiting on the queue
- * designated by id.
- *
- * Input parameters:
- * id - pointer to message queue
- * buffer - pointer to message buffer
- * size - size of message to broadcast
- * count - pointer to area to store number of threads made ready
- *
- * Output parameters:
- * count - number of threads made ready
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_message_queue_broadcast(
rtems_id id,
const void *buffer,
diff --git a/cpukit/rtems/src/msgqurgent.c b/cpukit/rtems/src/msgqurgent.c
index 256f8206ad..fd749fabfc 100644
--- a/cpukit/rtems/src/msgqurgent.c
+++ b/cpukit/rtems/src/msgqurgent.c
@@ -1,6 +1,11 @@
-/*
- * Message Queue Manager - rtems_message_queue_urgent
+/**
+ * @file
*
+ * @brief RTEMS Urgent Message Queue
+ * @ingroup ClassicMessageQueue
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -31,22 +36,6 @@
#include <rtems/rtems/options.h>
#include <rtems/rtems/support.h>
-/*
- * rtems_message_queue_urgent
- *
- * This routine implements the directives rtems_message_queue_urgent. It
- * prepends a message to the specified message queue.
- *
- * Input parameters:
- * id - pointer to message queue
- * buffer - pointer to message buffer
- * size - size of message to send urgently
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
#if defined(RTEMS_MULTIPROCESSING)
#define MESSAGE_QUEUE_MP_HANDLER _Message_queue_Core_message_queue_mp_support
#else
diff --git a/cpukit/rtems/src/partident.c b/cpukit/rtems/src/partident.c
index 83185c8a02..44b033956f 100644
--- a/cpukit/rtems/src/partident.c
+++ b/cpukit/rtems/src/partident.c
@@ -1,7 +1,11 @@
-/*
- * Partition Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Partition Name to Id
+ * @ingroup ClassicPart
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -23,23 +27,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/sysstate.h>
-/*
- * rtems_partition_ident
- *
- * This directive returns the system ID associated with
- * the partition name.
- *
- * Input parameters:
- * name - user defined partition name
- * node - node(s) to be searched
- * id - pointer to partition id
- *
- * Output parameters:
- * *id - partition id
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_partition_ident(
rtems_name name,
uint32_t node,
diff --git a/cpukit/rtems/src/ratemondata.c b/cpukit/rtems/src/ratemondata.c
index b591934666..f7a9d1707e 100644
--- a/cpukit/rtems/src/ratemondata.c
+++ b/cpukit/rtems/src/ratemondata.c
@@ -1,6 +1,11 @@
-/*
- * Rate Monotonic Manager -- Instantiate Data
+/**
+ * @file
*
+ * @brief Instantiate RTEMS Period Data
+ * @ingroup ClassicRateMon
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
diff --git a/cpukit/rtems/src/ratemontimeout.c b/cpukit/rtems/src/ratemontimeout.c
index 9ab0c59044..183e62fdcc 100644
--- a/cpukit/rtems/src/ratemontimeout.c
+++ b/cpukit/rtems/src/ratemontimeout.c
@@ -1,6 +1,11 @@
-/*
- * Rate Monotonic Manager -- Period End Timeout Handler
+/**
+ * @file
*
+ * @brief Rate Monotonic Timeout
+ * @ingroup ClassicRateMon
+ */
+
+/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -21,20 +26,6 @@
#include <rtems/rtems/ratemon.h>
#include <rtems/score/thread.h>
-/*
- * _Rate_monotonic_Timeout
- *
- * This routine processes a period ending. If the owning thread
- * is waiting for the period, that thread is unblocked and the
- * period reinitiated. Otherwise, the period is expired.
- * This routine is called by the watchdog handler.
- *
- * Input parameters:
- * id - period id
- *
- * Output parameters: NONE
- */
-
void _Rate_monotonic_Timeout(
Objects_Id id,
void *ignored
diff --git a/cpukit/rtems/src/regionresizesegment.c b/cpukit/rtems/src/regionresizesegment.c
index 82531fa374..3d8aeb646b 100644
--- a/cpukit/rtems/src/regionresizesegment.c
+++ b/cpukit/rtems/src/regionresizesegment.c
@@ -1,7 +1,11 @@
-/*
- * Region Manager
- *
+/**
+ * @file
*
+ * @brief Resize RTEMS Region Segment
+ * @ingroup ClassicRegion
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -24,22 +28,6 @@
#include <rtems/score/thread.h>
#include <rtems/score/apimutex.h>
-/*
- * rtems_region_resize_segment
- *
- * This directive will try to resize segment to the new size 'size'
- * "in place".
- *
- * Input parameters:
- * id - region id
- * segment - pointer to segment address
- * size - new required size
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_region_resize_segment(
rtems_id id,
void *segment,
diff --git a/cpukit/rtems/src/rtemsobjectgetname.c b/cpukit/rtems/src/rtemsobjectgetname.c
index 9064cc657d..f5f10651a0 100644
--- a/cpukit/rtems/src/rtemsobjectgetname.c
+++ b/cpukit/rtems/src/rtemsobjectgetname.c
@@ -1,6 +1,11 @@
-/*
- * RTEMS Object Helper -- Obtain Name of Object as String
+/**
+ * @file
*
+ * @brief Obtain Object Name as String
+ * @ingroup ClassicClassInfo
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -17,11 +22,6 @@
#include <rtems/score/object.h>
#include <rtems/rtems/object.h>
-/*
- * This method obtain the name of an object and returns its name
- * in the form of a C string. It attempts to be careful about
- * overflowing the user's string and about returning unprintable characters.
- */
char *rtems_object_get_name(
Objects_Id id,
size_t length,
diff --git a/cpukit/rtems/src/semflush.c b/cpukit/rtems/src/semflush.c
index 5b47718156..f6cfa7fa2c 100644
--- a/cpukit/rtems/src/semflush.c
+++ b/cpukit/rtems/src/semflush.c
@@ -1,11 +1,11 @@
-/*
- * rtems_semaphore_flush
- *
- * DESCRIPTION:
- *
- * This package is the implementation of the flush directive
- * of the Semaphore Manager.
+/**
+ * @file
*
+ * @brief RTEMS Semaphore Flush
+ * @ingroup ClassicSem
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -38,20 +38,6 @@
#include <rtems/score/interr.h>
-/*
- * rtems_semaphore_flush
- *
- * This directive allows a thread to flush the threads
- * pending on the semaphore.
- *
- * Input parameters:
- * id - semaphore id
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
#if defined(RTEMS_MULTIPROCESSING)
#define SEND_OBJECT_WAS_DELETED _Semaphore_MP_Send_object_was_deleted
#else
diff --git a/cpukit/rtems/src/semmp.c b/cpukit/rtems/src/semmp.c
index 2e85b20b90..1712c66a4f 100644
--- a/cpukit/rtems/src/semmp.c
+++ b/cpukit/rtems/src/semmp.c
@@ -1,7 +1,11 @@
-/*
- * Multiprocessing Support for the Semaphore Manager
- *
+/**
+ * @file
*
+ * @brief Semaphore MP Support
+ * @ingroup ClassicSEM
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,11 +34,6 @@ RTEMS_STATIC_ASSERT(
Semaphore_MP_Packet
);
-/*
- * _Semaphore_MP_Send_process_packet
- *
- */
-
void _Semaphore_MP_Send_process_packet (
Semaphore_MP_Remote_operations operation,
Objects_Id semaphore_id,
@@ -76,11 +75,6 @@ void _Semaphore_MP_Send_process_packet (
}
}
-/*
- * _Semaphore_MP_Send_request_packet
- *
- */
-
rtems_status_code _Semaphore_MP_Send_request_packet (
Semaphore_MP_Remote_operations operation,
Objects_Id semaphore_id,
@@ -128,11 +122,6 @@ rtems_status_code _Semaphore_MP_Send_request_packet (
return RTEMS_SUCCESSFUL;
}
-/*
- * _Semaphore_MP_Send_response_packet
- *
- */
-
void _Semaphore_MP_Send_response_packet (
Semaphore_MP_Remote_operations operation,
Objects_Id semaphore_id,
@@ -171,12 +160,6 @@ void _Semaphore_MP_Send_response_packet (
}
}
-/*
- *
- * _Semaphore_MP_Process_packet
- *
- */
-
void _Semaphore_MP_Process_packet (
rtems_packet_prefix *the_packet_prefix
)
@@ -257,11 +240,6 @@ void _Semaphore_MP_Process_packet (
}
}
-/*
- * _Semaphore_MP_Send_object_was_deleted
- *
- */
-
void _Semaphore_MP_Send_object_was_deleted (
Thread_Control *the_proxy
)
@@ -276,11 +254,6 @@ void _Semaphore_MP_Send_object_was_deleted (
}
-/*
- * _Semaphore_MP_Send_extract_proxy
- *
- */
-
void _Semaphore_MP_Send_extract_proxy (
void *argument
)
@@ -296,26 +269,11 @@ void _Semaphore_MP_Send_extract_proxy (
}
-/*
- * _Semaphore_MP_Get_packet
- *
- */
-
Semaphore_MP_Packet *_Semaphore_MP_Get_packet ( void )
{
return ( (Semaphore_MP_Packet *) _MPCI_Get_packet() );
}
-/*
- * _Semaphore_Core_mutex_mp_support
- *
- * Input parameters:
- * the_thread - the remote thread the semaphore was surrendered to
- * id - id of the surrendered semaphore
- *
- * Output parameters: NONE
- */
-
#if defined(RTEMS_MULTIPROCESSING)
void _Semaphore_Core_mutex_mp_support (
Thread_Control *the_thread,
@@ -332,17 +290,6 @@ void _Semaphore_Core_mutex_mp_support (
}
#endif
-
-/*
- * _Semaphore_Core_semaphore_mp_support
- *
- * Input parameters:
- * the_thread - the remote thread the semaphore was surrendered to
- * id - id of the surrendered semaphore
- *
- * Output parameters: NONE
- */
-
#if defined(RTEMS_MULTIPROCESSING)
void _Semaphore_Core_semaphore_mp_support (
Thread_Control *the_thread,
diff --git a/cpukit/rtems/src/taskcreate.c b/cpukit/rtems/src/taskcreate.c
index 9cd6b7bb09..64ad1ebd76 100644
--- a/cpukit/rtems/src/taskcreate.c
+++ b/cpukit/rtems/src/taskcreate.c
@@ -1,7 +1,11 @@
-/*
- * RTEMS Task Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Task Create
+ * @ingroup ClassicTasks
+ */
+
+/*
* COPYRIGHT (c) 1989-2008.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,27 +34,6 @@
#include <rtems/score/sysstate.h>
#include <rtems/score/apimutex.h>
-/*
- * rtems_task_create
- *
- * This directive creates a thread by allocating and initializing a
- * thread control block and a stack. The newly created thread is
- * placed in the dormant state.
- *
- * Input parameters:
- * name - user defined thread name
- * initial_priority - thread priority
- * stack_size - stack size in bytes
- * initial_modes - initial thread mode
- * attribute_set - thread attributes
- * id - pointer to thread id
- *
- * Output parameters:
- * id - thread id
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_task_create(
rtems_name name,
rtems_task_priority initial_priority,
diff --git a/cpukit/rtems/src/tasks.c b/cpukit/rtems/src/tasks.c
index 4164afe3c6..2385cb2d22 100644
--- a/cpukit/rtems/src/tasks.c
+++ b/cpukit/rtems/src/tasks.c
@@ -1,6 +1,11 @@
-/*
- * RTEMS Task Manager -- Initialize Manager
+/**
+ * @file
*
+ * @brief RTEMS Task API Extensions
+ * @ingroup ClassicTasks
+ */
+
+/*
* COPYRIGHT (c) 1989-2009.
* On-Line Applications Research Corporation (OAR).
*
@@ -230,16 +235,6 @@ User_extensions_Control _RTEMS_tasks_User_extensions = {
}
};
-/*
- * _RTEMS_tasks_Manager_initialization
- *
- * This routine initializes all Task Manager related data structures.
- *
- * Input parameters: NONE
- *
- * Output parameters: NONE
- */
-
void _RTEMS_tasks_Manager_initialization(void)
{
_Objects_Initialize_information(
@@ -279,17 +274,6 @@ void _RTEMS_tasks_Manager_initialization(void)
}
-/*
- * _RTEMS_tasks_Initialize_user_tasks
- *
- * This routine creates and starts all configured user
- * initialization threads.
- *
- * Input parameters: NONE
- *
- * Output parameters: NONE
- */
-
void _RTEMS_tasks_Initialize_user_tasks( void )
{
if ( _RTEMS_tasks_Initialize_user_tasks_p )
diff --git a/cpukit/rtems/src/taskvariabledelete.c b/cpukit/rtems/src/taskvariabledelete.c
index 42f773cfab..cb13b98d0a 100644
--- a/cpukit/rtems/src/taskvariabledelete.c
+++ b/cpukit/rtems/src/taskvariabledelete.c
@@ -1,7 +1,11 @@
-/*
- * rtems_task_variable_delete - Delete a per-task variable
- *
+/**
+ * @file
*
+ * @brief RTEMS Delete Task Variable
+ * @ingroup ClassicTasks
+ */
+
+/*
* COPYRIGHT (c) 1989-2007.
* On-Line Applications Research Corporation (OAR).
*
@@ -18,12 +22,6 @@
#include <rtems/rtems/tasks.h>
#include <rtems/score/wkspace.h>
-/*
- * rtems_task_variable_delete
- *
- * This directive removes a task variable.
- */
-
rtems_status_code rtems_task_variable_delete(
rtems_id tid,
void **ptr
diff --git a/cpukit/rtems/src/taskwakeafter.c b/cpukit/rtems/src/taskwakeafter.c
index bf28e0b902..1df86553f8 100644
--- a/cpukit/rtems/src/taskwakeafter.c
+++ b/cpukit/rtems/src/taskwakeafter.c
@@ -1,7 +1,11 @@
-/*
- * RTEMS Task Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Task Wake After
+ * @ingroup ClassicTasks
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,19 +34,6 @@
#include <rtems/score/apiext.h>
#include <rtems/score/sysstate.h>
-/*
- * rtems_task_wake_after
- *
- * This directive suspends the requesting thread for the given amount
- * of ticks.
- *
- * Input parameters:
- * ticks - number of ticks to wait
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - always successful
- */
-
rtems_status_code rtems_task_wake_after(
rtems_interval ticks
)
diff --git a/cpukit/rtems/src/taskwakewhen.c b/cpukit/rtems/src/taskwakewhen.c
index 0a420b20b6..ffa5ddcaeb 100644
--- a/cpukit/rtems/src/taskwakewhen.c
+++ b/cpukit/rtems/src/taskwakewhen.c
@@ -1,7 +1,11 @@
-/*
- * RTEMS Task Manager
- *
+/**
+ * @file
*
+ * @brief RTEMS Task Wake When
+ * @ingroup ClassicTasks
+ */
+
+/*
* COPYRIGHT (c) 1989-1999.
* On-Line Applications Research Corporation (OAR).
*
@@ -30,20 +34,6 @@
#include <rtems/score/apiext.h>
#include <rtems/score/sysstate.h>
-/*
- * rtems_task_wake_when
- *
- * This directive blocks the requesting thread until the given date and
- * time is reached.
- *
- * Input parameters:
- * time_buffer - pointer to the time and date structure
- *
- * Output parameters:
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- */
-
rtems_status_code rtems_task_wake_when(
rtems_time_of_day *time_buffer
)
diff --git a/cpukit/rtems/src/timergetinfo.c b/cpukit/rtems/src/timergetinfo.c
index af24c7a0bd..c6088a1a66 100644
--- a/cpukit/rtems/src/timergetinfo.c
+++ b/cpukit/rtems/src/timergetinfo.c
@@ -1,7 +1,11 @@
-/*
- * Timer Manager - rtems_timer_get_information directive
- *
+/**
+ * @file
*
+ * @brief RTEMS Get Timer Information
+ * @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_get_information
- *
- * This directive allows a thread to obtain information about a timer.
- *
- * Input parameters:
- * id - timer id
- * the_info - pointer to timer information block
- *
- * Output parameters:
- * *the_info - region information block filled in
- * RTEMS_SUCCESSFUL - if successful
- * error code - if unsuccessful
- *
- */
-
rtems_status_code rtems_timer_get_information(
rtems_id id,
rtems_timer_information *the_info