[rtems commit] rtems misc: Clean up Doxygen GCI Task #4

Gedare Bloom gedare at rtems.org
Tue Dec 4 22:55:35 UTC 2012


Module:    rtems
Branch:    master
Commit:    c18e0ba12799ea40693428b0a731bb561e61cab0
Changeset: http://git.rtems.org/rtems/commit/?id=c18e0ba12799ea40693428b0a731bb561e61cab0

Author:    Alex Ivanov <alexivanov97 at gmail.com>
Date:      Tue Dec  4 17:59:11 2012 -0500

rtems misc: Clean up Doxygen GCI Task #4

http://www.google-melange.com/gci/task/view/google/gci2012/7950205

---

 cpukit/rtems/include/rtems/rtems/dpmem.h      |    2 +-
 cpukit/rtems/include/rtems/rtems/event.h      |    3 ++
 cpukit/rtems/include/rtems/rtems/message.h    |   31 +++++++++++++++-----
 cpukit/rtems/include/rtems/rtems/object.h     |    4 +-
 cpukit/rtems/include/rtems/rtems/region.h     |   23 +++++++++++----
 cpukit/rtems/include/rtems/rtems/sem.h        |   10 +++++-
 cpukit/rtems/include/rtems/rtems/signalmp.h   |    8 ++--
 cpukit/rtems/include/rtems/rtems/status.h     |    2 +
 cpukit/rtems/include/rtems/rtems/tasks.h      |   18 ++++++++++-
 cpukit/rtems/include/rtems/rtems/timer.h      |    2 +
 cpukit/rtems/src/clockget.c                   |   26 ++++------------
 cpukit/rtems/src/clockgettodtimeval.c         |    9 ++++-
 cpukit/rtems/src/dpmem.c                      |   20 ++++--------
 cpukit/rtems/src/eventtimeout.c               |    9 ++++-
 cpukit/rtems/src/msg.c                        |   21 ++++---------
 cpukit/rtems/src/msgqcreate.c                 |   29 ++++--------------
 cpukit/rtems/src/msgqtranslatereturncode.c    |   21 ++++---------
 cpukit/rtems/src/regiongetsegment.c           |   28 ++++-------------
 cpukit/rtems/src/rtemsbuildname.c             |    9 ++++-
 cpukit/rtems/src/rtemsobjectgetapiclassname.c |    9 ++++-
 cpukit/rtems/src/rtemsobjectgetclassinfo.c    |    9 ++++-
 cpukit/rtems/src/rtemsobjectidapiminimum.c    |    9 ++++-
 cpukit/rtems/src/rtemsobjectidgetclass.c      |    9 ++++-
 cpukit/rtems/src/rtemstimerdata.c             |   10 ++++--
 cpukit/rtems/src/sem.c                        |   33 ++++-----------------
 cpukit/rtems/src/semdelete.c                  |   38 ++++--------------------
 cpukit/rtems/src/signalmp.c                   |   31 ++++---------------
 cpukit/rtems/src/status.c                     |   12 ++++---
 cpukit/rtems/src/taskresume.c                 |   24 ++++-----------
 cpukit/rtems/src/tasksetnote.c                |   25 ++++------------
 30 files changed, 218 insertions(+), 266 deletions(-)

diff --git a/cpukit/rtems/include/rtems/rtems/dpmem.h b/cpukit/rtems/include/rtems/rtems/dpmem.h
index 4869dee..a4cf251 100644
--- a/cpukit/rtems/include/rtems/rtems/dpmem.h
+++ b/cpukit/rtems/include/rtems/rtems/dpmem.h
@@ -77,7 +77,7 @@ typedef struct {
 RTEMS_DPMEM_EXTERN Objects_Information  _Dual_ported_memory_Information;
 
 /**
- *  @brief _Dual_ported_memory_Manager_initialization
+ *  @brief Dual Ported Memory Manager Initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/event.h b/cpukit/rtems/include/rtems/rtems/event.h
index 8386c43..b3762b2 100644
--- a/cpukit/rtems/include/rtems/rtems/event.h
+++ b/cpukit/rtems/include/rtems/rtems/event.h
@@ -469,6 +469,9 @@ void _Event_Surrender(
   States_Control                    wait_state
 );
 
+/**
+ *  @brief Timeout Event
+ */
 void _Event_Timeout(
   Objects_Id  id,
   void       *arg
diff --git a/cpukit/rtems/include/rtems/rtems/message.h b/cpukit/rtems/include/rtems/rtems/message.h
index fa80862..9990b14 100644
--- a/cpukit/rtems/include/rtems/rtems/message.h
+++ b/cpukit/rtems/include/rtems/rtems/message.h
@@ -97,21 +97,32 @@ typedef struct {
 RTEMS_MESSAGE_EXTERN Objects_Information  _Message_queue_Information;
 
 /**
- *  @brief Message_queue_Manager_initialization
+ *  @brief Message Queue Manager Initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
 void _Message_queue_Manager_initialization(void);
 
 /**
- *  @brief rtems_message_queue_create
+ *  @brief RTEMS Create Message Queue
  *
  *  This routine implements the rtems_message_queue_create directive.  The
- *  message queue will have the name name.  If the attribute_set indicates
+ *  message queue will have the @a name.  If the @a attribute_set indicates
  *  that the message queue is to be limited in the number of messages
- *  that can be outstanding, then count indicates the maximum number of
+ *  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 ID.
+ *  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
+ *          be filled in with the queue id.
  */
 rtems_status_code rtems_message_queue_create(
   rtems_name       name,
@@ -296,10 +307,14 @@ rtems_status_code _Message_queue_Submit(
 Message_queue_Control *_Message_queue_Allocate (void);
 
 /**
- *  @brief Message_queue_Translate_core_message_queue_return_code
+ *  @brief Message queue Translate Core Message Queue Return Code
  *
- *  This function returns a RTEMS status code based on the core message queue
- *  status code specified.
+ *  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 (
   uint32_t   the_message_queue_status
diff --git a/cpukit/rtems/include/rtems/rtems/object.h b/cpukit/rtems/include/rtems/rtems/object.h
index ced287f..d8c1aa1 100644
--- a/cpukit/rtems/include/rtems/rtems/object.h
+++ b/cpukit/rtems/include/rtems/rtems/object.h
@@ -167,7 +167,7 @@ rtems_status_code rtems_object_set_name(
 /**
  *  @brief Get Class Portion of Object Id
  *
- *  This function returns the class portion of the ID.
+ *  This function returns the class portion of the @a _id ID.
  *
  *  @param[in] _id is the Id of the object to obtain the class from
  *
@@ -327,7 +327,7 @@ const char *rtems_object_get_api_class_name(
 );
 
 /**
- *  @brief Get Class Name
+ *  @brief Get Class Information
  *
  *  This method returns a string containing the name of the
  *  @a the_class from the specified @a api.
diff --git a/cpukit/rtems/include/rtems/rtems/region.h b/cpukit/rtems/include/rtems/rtems/region.h
index 61162cb..055e25d 100644
--- a/cpukit/rtems/include/rtems/rtems/region.h
+++ b/cpukit/rtems/include/rtems/rtems/region.h
@@ -176,15 +176,26 @@ rtems_status_code rtems_region_delete(
 );
 
 /**
- *  @brief rtems_region_get_segment
+ *  @brief RTEMS Get Region Segment
  *
  *  This routine implements the rtems_region_get_segment directive.  It
- *  attempts to allocate a segment from the region associated with ID.
- *  If a segment of the requested size can be allocated, its address
- *  is returned in segment.  If no segment is available, then the task
+ *  attempts to allocate a segment from the region associated with @a id.
+ *  If a segment of the requested @a size size can be allocated, its address
+ *  is returned in @a segment.  If no segment is available, then the task
  *  may return immediately or block waiting for a segment with an optional
- *  timeout of timeout clock ticks.  Whether the task blocks or returns
- *  immediately is based on the no_wait option in the option_set.
+ *  timeout of @a timeout clock ticks.  Whether the task blocks or returns
+ *  immediately is based on the no_wait option in the @a option_set.
+ * 
+ *  @param[in] id is the region id
+ *  @param[in] size is the segment size in bytes
+ *  @param[in] option_set is the wait option
+ *  @param[in] timeout is the number of ticks to wait (0 means wait forever)
+ *  @param[in] segment is the pointer to segment address
+ * 
+ *  @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 segment will
+ *          be filled in with the segment address. 
  */
 rtems_status_code rtems_region_get_segment(
   rtems_id           id,
diff --git a/cpukit/rtems/include/rtems/rtems/sem.h b/cpukit/rtems/include/rtems/rtems/sem.h
index a75ef41..2322088 100644
--- a/cpukit/rtems/include/rtems/rtems/sem.h
+++ b/cpukit/rtems/include/rtems/rtems/sem.h
@@ -104,7 +104,7 @@ typedef struct {
 RTEMS_SEM_EXTERN Objects_Information  _Semaphore_Information;
 
 /**
- *  @brief Semaphore_Manager_initialization
+ *  @brief Semaphore Manager Initialization
  *
  *  This routine performs the initialization necessary for this manager.
  */
@@ -152,10 +152,16 @@ rtems_status_code rtems_semaphore_ident(
 );
 
 /**
- *  @brief rtems_semaphore_delete
+ *  @brief RTEMS Delete Semaphore
  *
  *  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.
  */
 rtems_status_code rtems_semaphore_delete(
   rtems_id   id
diff --git a/cpukit/rtems/include/rtems/rtems/signalmp.h b/cpukit/rtems/include/rtems/rtems/signalmp.h
index d05daa8..2b373a9 100644
--- a/cpukit/rtems/include/rtems/rtems/signalmp.h
+++ b/cpukit/rtems/include/rtems/rtems/signalmp.h
@@ -65,7 +65,7 @@ typedef struct {
  */
 
 /**
- *  @brief Signal_MP_Send_request_packet
+ *  @brief Signal MP Send Request Packet
  *
  *  This routine performs a remote procedure call so that a
  *  directive operation can be initiated on another node.
@@ -77,7 +77,7 @@ rtems_status_code _Signal_MP_Send_request_packet (
 );
 
 /**
- *  @brief Signal_MP_Send_response_packet
+ *  @brief Signal MP Send Response Packet
  *
  *  This routine performs a remote procedure call so that a
  *  directive can be performed on another node.
@@ -88,7 +88,7 @@ void _Signal_MP_Send_response_packet (
 );
 
 /**
- *  @brief Signal_MP_Process_packet
+ *  @brief Signal MP Process Packet
  *
  *  This routine performs the actions specific to this package for
  *  the request from another node.
@@ -120,7 +120,7 @@ void _Signal_MP_Process_packet (
  */
 
 /**
- *  @brief Signal_MP_Get_packet
+ *  @brief Signal MP Get Packet
  *
  *  This function is used to obtain a signal mp packet.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/status.h b/cpukit/rtems/include/rtems/rtems/status.h
index 2718d4f..bb2646e 100644
--- a/cpukit/rtems/include/rtems/rtems/status.h
+++ b/cpukit/rtems/include/rtems/rtems/status.h
@@ -183,6 +183,8 @@ typedef enum {
 #define RTEMS_STATUS_CODES_LAST  RTEMS_PROXY_BLOCKING
 
 /**
+ *  @brief Status Object Name Errors to Status Array
+ * 
  *  This array is used to map SuperCore Object Handler return
  *  codes to Classic API status codes.
  */
diff --git a/cpukit/rtems/include/rtems/rtems/tasks.h b/cpukit/rtems/include/rtems/rtems/tasks.h
index 03795d5..90379c1 100644
--- a/cpukit/rtems/include/rtems/rtems/tasks.h
+++ b/cpukit/rtems/include/rtems/rtems/tasks.h
@@ -324,11 +324,19 @@ rtems_status_code rtems_task_get_note(
 );
 
 /**
- *  @brief rtems_task_set_note
+ *  @brief RTEMS Set Task 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.
  */
 rtems_status_code rtems_task_set_note(
   rtems_id   id,
@@ -378,10 +386,16 @@ rtems_status_code rtems_task_suspend(
 );
 
 /**
- *  @brief rtems_task_resume
+ *  @brief RTEMS Resume Task
  *
  *  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.
  */
 rtems_status_code rtems_task_resume(
   rtems_id   id
diff --git a/cpukit/rtems/include/rtems/rtems/timer.h b/cpukit/rtems/include/rtems/rtems/timer.h
index b75a474..ee35fec 100644
--- a/cpukit/rtems/include/rtems/rtems/timer.h
+++ b/cpukit/rtems/include/rtems/rtems/timer.h
@@ -37,6 +37,8 @@
 #define _RTEMS_RTEMS_TIMER_H
 
 /**
+ *  @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
diff --git a/cpukit/rtems/src/clockget.c b/cpukit/rtems/src/clockget.c
index 476d046..45f4c29 100644
--- a/cpukit/rtems/src/clockget.c
+++ b/cpukit/rtems/src/clockget.c
@@ -1,6 +1,11 @@
-/*
- *  Clock Manager
+/**
+ *  @file
  *
+ *  @brief Obtain Current Time of Day
+ *  @ingroup ClassicClock
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -21,23 +26,6 @@
 #include <rtems/score/tod.h>
 #include <rtems/score/watchdog.h>
 
-/*
- *  rtems_clock_get
- *
- *  This directive returns the current date and time.  If the time has
- *  not been set by a tm_set then an error is returned.
- *
- *  Input parameters:
- *    option      - which value to return
- *    time_buffer - pointer to output buffer (a time and date structure
- *                  or an interval)
- *
- *  Output parameters:
- *    time_buffer      - output filled in
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_clock_get(
   rtems_clock_get_options  option,
   void                    *time_buffer
diff --git a/cpukit/rtems/src/clockgettodtimeval.c b/cpukit/rtems/src/clockgettodtimeval.c
index a3fb49d..b2d7c52 100644
--- a/cpukit/rtems/src/clockgettodtimeval.c
+++ b/cpukit/rtems/src/clockgettodtimeval.c
@@ -1,6 +1,11 @@
-/*
- *  Clock Manager - Get TOD in Time Value Format
+/**
+ *  @file
  *
+ *  @brief Obtain TOD in struct timeval Format
+ *  @ingroup ClassicClock
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/dpmem.c b/cpukit/rtems/src/dpmem.c
index 168082d..88f06ca 100644
--- a/cpukit/rtems/src/dpmem.c
+++ b/cpukit/rtems/src/dpmem.c
@@ -1,6 +1,11 @@
-/*
- *  Dual Port Memory Manager
+/**
+ *  @file
  *
+ *  @brief Dual Ported Memory Manager Initialization
+ *  @ingroup ClassicDPMEM
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -22,17 +27,6 @@
 #include <rtems/score/object.h>
 #include <rtems/score/thread.h>
 
-/*
- *  _Dual_ported_memory_Manager_initialization
- *
- *  This routine initializes all dual-ported memory manager related
- *  data structures.
- *
- *  Input parameters:   NONE
- *
- *  Output parameters:  NONE
- */
-
 void _Dual_ported_memory_Manager_initialization(void)
 {
   _Objects_Initialize_information(
diff --git a/cpukit/rtems/src/eventtimeout.c b/cpukit/rtems/src/eventtimeout.c
index 6e81a80..58dee84 100644
--- a/cpukit/rtems/src/eventtimeout.c
+++ b/cpukit/rtems/src/eventtimeout.c
@@ -1,6 +1,11 @@
-/*
- *  Event Manager
+/**
+ *  @file
  *
+ *  @brief Timeout Event
+ *  @ingroup ClassicEvent
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/msg.c b/cpukit/rtems/src/msg.c
index 009cc28..9ce07eb 100644
--- a/cpukit/rtems/src/msg.c
+++ b/cpukit/rtems/src/msg.c
@@ -1,7 +1,11 @@
-/*
- *  Message Queue Manager
- *
+/**
+ *  @file
  *
+ *  @brief Message Queue Manager Initialization
+ *  @ingroup ClassicMessageQueue
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -33,17 +37,6 @@
 #include <rtems/rtems/options.h>
 #include <rtems/rtems/support.h>
 
-/*
- *  _Message_queue_Manager_initialization
- *
- *  This routine initializes all message queue manager related
- *  data structures.
- *
- *  Input parameters:   NONE
- *
- *  Output parameters:  NONE
- */
-
 void _Message_queue_Manager_initialization(void)
 {
   _Objects_Initialize_information(
diff --git a/cpukit/rtems/src/msgqcreate.c b/cpukit/rtems/src/msgqcreate.c
index a5cce2b..e65dcac 100644
--- a/cpukit/rtems/src/msgqcreate.c
+++ b/cpukit/rtems/src/msgqcreate.c
@@ -1,7 +1,11 @@
-/*
- *  Message Queue Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Create Message Queue
+ *  @ingroup ClassicMessageQueue
+ */
+
+/*
  *  COPYRIGHT (c) 1989-1999.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -32,25 +36,6 @@
 #include <rtems/rtems/options.h>
 #include <rtems/rtems/support.h>
 
-/*
- *  rtems_message_queue_create
- *
- *  This directive creates a message queue by allocating and initializing
- *  a message queue data structure.
- *
- *  Input parameters:
- *    name             - user defined queue name
- *    count            - maximum message and reserved buffer count
- *    max_message_size - maximum size of each message
- *    attribute_set    - process method
- *    id               - pointer to queue
- *
- *  Output parameters:
- *    id                - queue id
- *    RTEMS_SUCCESSFUL  - if successful
- *    error code        - if unsuccessful
- */
-
 rtems_status_code rtems_message_queue_create(
   rtems_name       name,
   uint32_t         count,
diff --git a/cpukit/rtems/src/msgqtranslatereturncode.c b/cpukit/rtems/src/msgqtranslatereturncode.c
index aa3ba0c..d7d1a56 100644
--- a/cpukit/rtems/src/msgqtranslatereturncode.c
+++ b/cpukit/rtems/src/msgqtranslatereturncode.c
@@ -1,7 +1,11 @@
-/*
- *  Message Queue Manager
- *
+/**
+ *  @file
  *
+ *  @brief Message queue Translate Core Message Queue Return Code
+ *  @ingroup ClassicMessageQueue
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -32,17 +36,6 @@
 #include <rtems/rtems/options.h>
 #include <rtems/rtems/support.h>
 
-/*
- *  _Message_queue_Translate_core_message_queue_return_code
- *
- *  Input parameters:
- *    the_message_queue_status - message_queue status code to translate
- *
- *  Output parameters:
- *    rtems status code - translated RTEMS status code
- *
- */
-
 rtems_status_code _Message_queue_Translate_core_return_code_[] = {
   RTEMS_SUCCESSFUL,         /* CORE_MESSAGE_QUEUE_STATUS_SUCCESSFUL */
   RTEMS_INVALID_SIZE,       /* CORE_MESSAGE_QUEUE_STATUS_INVALID_SIZE */
diff --git a/cpukit/rtems/src/regiongetsegment.c b/cpukit/rtems/src/regiongetsegment.c
index 81d363a..1f38e5c 100644
--- a/cpukit/rtems/src/regiongetsegment.c
+++ b/cpukit/rtems/src/regiongetsegment.c
@@ -1,7 +1,11 @@
-/*
- *  Region Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Get Region Segment
+ *  @ingroup ClassicRegion
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -24,24 +28,6 @@
 #include <rtems/score/thread.h>
 #include <rtems/score/apimutex.h>
 
-/*
- *  rtems_region_get_segment
- *
- *  This directive will obtain a segment from the given region.
- *
- *  Input parameters:
- *    id         - region id
- *    size       - segment size in bytes
- *    option_set - wait option
- *    timeout    - number of ticks to wait (0 means wait forever)
- *    segment    - pointer to segment address
- *
- *  Output parameters:
- *    segment    - pointer to segment address filled in
- *    RTEMS_SUCCESSFUL - if successful
- *    error code - if unsuccessful
- */
-
 rtems_status_code rtems_region_get_segment(
   rtems_id           id,
   uintptr_t          size,
diff --git a/cpukit/rtems/src/rtemsbuildname.c b/cpukit/rtems/src/rtemsbuildname.c
index a37db76..472a71b 100644
--- a/cpukit/rtems/src/rtemsbuildname.c
+++ b/cpukit/rtems/src/rtemsbuildname.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Build an Object Name
+/**
+ *  @file
  *
+ *  @brief Build Thirty-Two Bit Object Name
+ *  @ingroup ClassicClassInfo
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectgetapiclassname.c b/cpukit/rtems/src/rtemsobjectgetapiclassname.c
index 2550006..9349582 100644
--- a/cpukit/rtems/src/rtemsobjectgetapiclassname.c
+++ b/cpukit/rtems/src/rtemsobjectgetapiclassname.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Obtain Name of API
+/**
+ *  @file
  *
+ *  @brief Get Class Name
+ *  @ingroup ClassicClassInfo
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectgetclassinfo.c b/cpukit/rtems/src/rtemsobjectgetclassinfo.c
index aceab69..c801c66 100644
--- a/cpukit/rtems/src/rtemsobjectgetclassinfo.c
+++ b/cpukit/rtems/src/rtemsobjectgetclassinfo.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Get Information on Class
+/**
+ *  @file
  *
+ *  @brief Get Class Information
+ *  @ingroup ClassicClassInfo
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectidapiminimum.c b/cpukit/rtems/src/rtemsobjectidapiminimum.c
index 0c85a14..c6eb871 100644
--- a/cpukit/rtems/src/rtemsobjectidapiminimum.c
+++ b/cpukit/rtems/src/rtemsobjectidapiminimum.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Get Least Valid API Number
+/**
+ *  @file
  *
+ *  @brief Get Lowest Valid API Index
+ *  @ingroup ClassicClassInfo
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemsobjectidgetclass.c b/cpukit/rtems/src/rtemsobjectidgetclass.c
index 2a1a47f..a9b7df7 100644
--- a/cpukit/rtems/src/rtemsobjectidgetclass.c
+++ b/cpukit/rtems/src/rtemsobjectidgetclass.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Object Helper -- Extract Class From Id
+/**
+ *  @file
  *
+ *  @brief Get Class Portion of Object Id
+ *  @ingroup ClassicClassInfo
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
diff --git a/cpukit/rtems/src/rtemstimerdata.c b/cpukit/rtems/src/rtemstimerdata.c
index 6a73561..b3ed7e9 100644
--- a/cpukit/rtems/src/rtemstimerdata.c
+++ b/cpukit/rtems/src/rtemstimerdata.c
@@ -1,6 +1,11 @@
-/*
- *  Timer Manager -- Instantiate Data
+/**
+ *  @file
  *
+ *  @brief Instantiate RTEMS Timer Data
+ *  @ingroup ClassicTimer
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -13,7 +18,6 @@
 #include "config.h"
 #endif
 
-/* instantiate RTEMS timer data */
 #define RTEMS_TIMER_EXTERN
 
 #include <rtems/system.h>
diff --git a/cpukit/rtems/src/sem.c b/cpukit/rtems/src/sem.c
index 76c753e..4e22dac 100644
--- a/cpukit/rtems/src/sem.c
+++ b/cpukit/rtems/src/sem.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 Manager Initialization
+ *  @ingroup ClassicSem
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -48,16 +39,6 @@
 
 #include <rtems/score/interr.h>
 
-/*
- *  _Semaphore_Manager_initialization
- *
- *  This routine initializes all semaphore manager related data structures.
- *
- *  Input parameters:   NONE
- *
- *  Output parameters:  NONE
- */
-
 void _Semaphore_Manager_initialization(void)
 {
   _Objects_Initialize_information(
diff --git a/cpukit/rtems/src/semdelete.c b/cpukit/rtems/src/semdelete.c
index 54625fa..57e00db 100644
--- a/cpukit/rtems/src/semdelete.c
+++ b/cpukit/rtems/src/semdelete.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 RTEMS Delete Semaphore
+ *  @ingroup ClassicSem
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -47,21 +38,6 @@
 
 #include <rtems/score/interr.h>
 
-/*
- *  rtems_semaphore_delete
- *
- *  This directive allows a thread to delete a semaphore specified by
- *  the semaphore id.  The semaphore is freed back to the inactive
- *  semaphore chain.
- *
- *  Input parameters:
- *    id - semaphore id
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 #if defined(RTEMS_MULTIPROCESSING)
 #define SEMAPHORE_MP_OBJECT_WAS_DELETED _Semaphore_MP_Send_object_was_deleted
 #else
diff --git a/cpukit/rtems/src/signalmp.c b/cpukit/rtems/src/signalmp.c
index b07f160..f70a452 100644
--- a/cpukit/rtems/src/signalmp.c
+++ b/cpukit/rtems/src/signalmp.c
@@ -1,7 +1,11 @@
-/*
- *  Multiprocessing Support for the Signal Manager
- *
+/**
+ *  @file
  *
+ *  @brief Signal MP Support
+ *  @ingroup ClassicSignalMP
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -39,11 +43,6 @@ RTEMS_STATIC_ASSERT(
  *
  */
 
-/*
- *  _Signal_MP_Send_request_packet
- *
- */
-
 rtems_status_code _Signal_MP_Send_request_packet (
   Signal_MP_Remote_operations operation,
   Objects_Id                  task_id,
@@ -82,11 +81,6 @@ rtems_status_code _Signal_MP_Send_request_packet (
   return RTEMS_INTERNAL_ERROR;
 }
 
-/*
- *  _Signal_MP_Send_response_packet
- *
- */
-
 void _Signal_MP_Send_response_packet (
   Signal_MP_Remote_operations  operation,
   Thread_Control              *the_thread
@@ -119,12 +113,6 @@ void _Signal_MP_Send_response_packet (
   }
 }
 
-/*
- *
- *  _Signal_MP_Process_packet
- *
- */
-
 void _Signal_MP_Process_packet (
   rtems_packet_prefix  *the_packet_prefix
 )
@@ -175,11 +163,6 @@ void _Signal_MP_Process_packet (
  *
  */
 
-/*
- *  _Signal_MP_Get_packet
- *
- */
-
 Signal_MP_Packet *_Signal_MP_Get_packet ( void )
 {
   return ( (Signal_MP_Packet *) _MPCI_Get_packet() );
diff --git a/cpukit/rtems/src/status.c b/cpukit/rtems/src/status.c
index 27d60b5..f89a5e7 100644
--- a/cpukit/rtems/src/status.c
+++ b/cpukit/rtems/src/status.c
@@ -1,3 +1,10 @@
+/**
+ *  @file
+ *
+ *  @brief Status Object Name Errors to Status Array
+ *  @ingroup ClassicStatus
+ */
+
 /*  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -8,11 +15,6 @@
 
 #include <rtems/rtems/status.h>
 
-/**
- *  This array is used to map SuperCore Object Handler return
- *  codes to Classic API status codes.
- */
-
 const rtems_status_code _Status_Object_name_errors_to_status[] = {
   /** This maps OBJECTS_SUCCESSFUL to RTEMS_SUCCESSFUL. */
   RTEMS_SUCCESSFUL,
diff --git a/cpukit/rtems/src/taskresume.c b/cpukit/rtems/src/taskresume.c
index e53b542..a3a8f73 100644
--- a/cpukit/rtems/src/taskresume.c
+++ b/cpukit/rtems/src/taskresume.c
@@ -1,7 +1,11 @@
-/*
- *  RTEMS Task Manager
- *
+/**
+ *  @file
  *
+ *  @brief RTEMS Resume Task
+ *  @ingroup ClassicTasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2007.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -29,20 +33,6 @@
 #include <rtems/score/apiext.h>
 #include <rtems/score/sysstate.h>
 
-/*
- *  rtems_task_resume
- *
- *  This directive will remove the specified thread
- *  from the suspended state.
- *
- *  Input parameters:
- *    id - thread id
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_task_resume(
   rtems_id id
 )
diff --git a/cpukit/rtems/src/tasksetnote.c b/cpukit/rtems/src/tasksetnote.c
index 453a2a2..b08198d 100644
--- a/cpukit/rtems/src/tasksetnote.c
+++ b/cpukit/rtems/src/tasksetnote.c
@@ -1,6 +1,11 @@
-/*
- *  RTEMS Task Manager
+/**
+ *  @file
  *
+ *  @brief RTEMS Set Task Note
+ *  @ingroup ClassicTasks
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2009.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -29,22 +34,6 @@
 #include <rtems/score/apiext.h>
 #include <rtems/score/sysstate.h>
 
-/*
- * rtems_task_set_note
- *
- *  This directive sets the specified notepad contents to the given
- *  note.
- *
- *  Input parameters:
- *    id      - thread id
- *    notepad - notepad number
- *    note    - note value
- *
- *  Output parameters:
- *    RTEMS_SUCCESSFUL - if successful
- *    error code       - if unsuccessful
- */
-
 rtems_status_code rtems_task_set_note(
   rtems_id id,
   uint32_t notepad,




More information about the vc mailing list