Score misc: Clean up Doxygen #4 (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/7985215

1 files changed, 7 insertions, 99 deletions

diff --git a/cpukit/score/src/mpci.c b/cpukit/score/src/mpci.c
index c4e8934ab6..98b99c7a7e 100644
--- a/cpukit/score/src/mpci.c
+++ b/cpukit/score/src/mpci.c
@@ -1,7 +1,11 @@
-/*
- *  Multiprocessing Communications Interface (MPCI) Handler
- *
+/**
+ * @file
  *
+ * @brief Multiprocessing Communications Interface (MPCI) Handler
+ * @ingroup ScoreMPCI
+ */
+
+/*
  *  COPYRIGHT (c) 1989-2008.
  *  On-Line Applications Research Corporation (OAR).
  *
@@ -42,12 +46,6 @@ RTEMS_STATIC_ASSERT(
  */
 CORE_semaphore_Control _MPCI_Semaphore;
 
-/*
- *  _MPCI_Handler_initialization
- *
- *  This subprogram performs the initialization necessary for this handler.
- */
-
 void _MPCI_Handler_initialization(
   uint32_t   timeout_status
 )
@@ -98,12 +96,6 @@ void _MPCI_Handler_initialization(
   );
 }
 
-/*
- *  _MPCI_Create_server
- *
- *  This subprogram creates the MPCI receive server.
- */
-
 void _MPCI_Create_server( void )
 {
   Objects_Name name;
@@ -144,25 +136,11 @@ void _MPCI_Create_server( void )
   );
 }
 
-/*
- *  _MPCI_Initialization
- *
- *  This subprogram initializes the MPCI driver by
- *  invoking the user provided MPCI initialization callout.
- */
-
 void _MPCI_Initialization ( void )
 {
   (*_MPCI_table->initialization)();
 }
 
-/*
- *  _MPCI_Register_packet_processor
- *
- *  This routine registers the MPCI packet processor for the
- *  designated object class.
- */
-
 void _MPCI_Register_packet_processor(
   MP_packet_Classes      the_class,
   MPCI_Packet_processor  the_packet_processor
@@ -172,13 +150,6 @@ void _MPCI_Register_packet_processor(
   _MPCI_Packet_processors[ the_class ] = the_packet_processor;
 }
 
-/*
- *  _MPCI_Get_packet
- *
- *  This subprogram obtains a packet by invoking the user provided
- *  MPCI get packet callout.
- */
-
 MP_packet_Prefix *_MPCI_Get_packet ( void )
 {
   MP_packet_Prefix  *the_packet;
@@ -202,13 +173,6 @@ MP_packet_Prefix *_MPCI_Get_packet ( void )
   return the_packet;
 }
 
-/*
- *  _MPCI_Return_packet
- *
- *  This subprogram returns a packet by invoking the user provided
- *  MPCI return packet callout.
- */
-
 void _MPCI_Return_packet (
   MP_packet_Prefix   *the_packet
 )
@@ -216,13 +180,6 @@ void _MPCI_Return_packet (
   (*_MPCI_table->return_packet)( the_packet );
 }
 
-/*
- *  _MPCI_Send_process_packet
- *
- *  This subprogram sends a process packet by invoking the user provided
- *  MPCI send callout.
- */
-
 void _MPCI_Send_process_packet (
   uint32_t            destination,
   MP_packet_Prefix   *the_packet
@@ -235,13 +192,6 @@ void _MPCI_Send_process_packet (
   (*_MPCI_table->send_packet)( destination, the_packet );
 }
 
-/*
- *  _MPCI_Send_request_packet
- *
- *  This subprogram sends a request packet by invoking the user provided
- *  MPCI send callout.
- */
-
 uint32_t   _MPCI_Send_request_packet (
   uint32_t            destination,
   MP_packet_Prefix   *the_packet,
@@ -280,13 +230,6 @@ uint32_t   _MPCI_Send_request_packet (
   return _Thread_Executing->Wait.return_code;
 }
 
-/*
- *  _MPCI_Send_response_packet
- *
- *  This subprogram sends a response packet by invoking the user provided
- *  MPCI send callout.
- */
-
 void _MPCI_Send_response_packet (
   uint32_t            destination,
   MP_packet_Prefix   *the_packet
@@ -297,13 +240,6 @@ void _MPCI_Send_response_packet (
   (*_MPCI_table->send_packet)( destination, the_packet );
 }
 
-/*
- *  _MPCI_Receive_packet
- *
- *  This subprogram receives a packet by invoking the user provided
- *  MPCI receive callout.
- */
-
 MP_packet_Prefix  *_MPCI_Receive_packet ( void )
 {
   MP_packet_Prefix  *the_packet;
@@ -313,13 +249,6 @@ MP_packet_Prefix  *_MPCI_Receive_packet ( void )
   return the_packet;
 }
 
-/*
- *  _MPCI_Process_response
- *
- *  This subprogram obtains a packet by invoking the user provided
- *  MPCI get packet callout.
- */
-
 Thread_Control *_MPCI_Process_response (
   MP_packet_Prefix  *the_packet
 )
@@ -396,11 +325,6 @@ Thread _MPCI_Receive_server(
   return 0;   /* unreached - only to remove warnings */
 }
 
-/*
- *  _MPCI_Announce
- *
- */
-
 void _MPCI_Announce ( void )
 {
   _Thread_Disable_dispatch();
@@ -408,11 +332,6 @@ void _MPCI_Announce ( void )
   _Thread_Enable_dispatch();
 }
 
-/*
- *  _MPCI_Internal_packets_Send_process_packet
- *
- */
-
 void _MPCI_Internal_packets_Send_process_packet (
    MPCI_Internal_Remote_operations operation
 )
@@ -454,12 +373,6 @@ void _MPCI_Internal_packets_Send_process_packet (
  *
  */
 
-/*
- *
- *  _MPCI_Internal_packets_Process_packet
- *
- */
-
 void _MPCI_Internal_packets_Process_packet (
   MP_packet_Prefix  *the_packet_prefix
 )
@@ -510,11 +423,6 @@ void _MPCI_Internal_packets_Process_packet (
  *
  */
 
-/*
- *  _MPCI_Internal_packets_Get_packet
- *
- */
-
 MPCI_Internal_packet *_MPCI_Internal_packets_Get_packet ( void )
 {
   return ( (MPCI_Internal_packet *) _MPCI_Get_packet() );