summaryrefslogtreecommitdiffstats
path: root/cpukit/rtems/include/rtems/rtems/semmp.h
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/include/rtems/rtems/semmp.h
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/include/rtems/rtems/semmp.h')
-rw-r--r--cpukit/rtems/include/rtems/rtems/semmp.h24
1 files changed, 15 insertions, 9 deletions
diff --git a/cpukit/rtems/include/rtems/rtems/semmp.h b/cpukit/rtems/include/rtems/rtems/semmp.h
index 1fc3d4af31..d592d33b3a 100644
--- a/cpukit/rtems/include/rtems/rtems/semmp.h
+++ b/cpukit/rtems/include/rtems/rtems/semmp.h
@@ -63,7 +63,7 @@ typedef struct {
} Semaphore_MP_Packet;
/**
- * @brief Semaphore_MP_Send_process_packet
+ * @brief Semaphore MP Send Process Packet
*
* This routine performs a remote procedure call so that a
* process operation can be performed on another node.
@@ -76,7 +76,7 @@ void _Semaphore_MP_Send_process_packet (
);
/**
- * @brief Semaphore_MP_Send_request_packet
+ * @brief Semaphore MP Send Request Packet
*
* This routine performs a remote procedure call so that a
* directive operation can be initiated on another node.
@@ -89,7 +89,7 @@ rtems_status_code _Semaphore_MP_Send_request_packet (
);
/**
- * @brief Semaphore_MP_Send_response_packet
+ * @brief Semaphore MP Send Response Packet
*
* This routine performs a remote procedure call so that a
* directive can be performed on another node.
@@ -101,7 +101,7 @@ void _Semaphore_MP_Send_response_packet (
);
/**
- * @brief Semaphore_MP_Process_packet
+ * @brief Semaphore MP Process Packet
*
* This routine performs the actions specific to this package for
* the request from another node.
@@ -111,7 +111,7 @@ void _Semaphore_MP_Process_packet (
);
/**
- * @brief Semaphore_MP_Send_object_was_deleted
+ * @brief Semaphore MP Send Object was Deleted
*
* This routine is invoked indirectly by the thread queue
* when a proxy has been removed from the thread queue and
@@ -122,7 +122,7 @@ void _Semaphore_MP_Send_object_was_deleted (
);
/**
- * @brief Semaphore_MP_Send_extract_proxy
+ * @brief Semaphore MP Send Extract Proxy
*
* This routine is invoked when a task is deleted and it
* has a proxy which must be removed from a thread queue and
@@ -133,18 +133,21 @@ void _Semaphore_MP_Send_extract_proxy (
);
/**
- * @brief Semaphore_MP_Get_packet
+ * @brief Semaphore MP Get Packet
*
* This function is used to obtain a semaphore mp packet.
*/
Semaphore_MP_Packet *_Semaphore_MP_Get_packet ( void );
/**
- * @brief _Semaphore_Core_mutex_mp_support
+ * @brief Semaphore Core Mutex MP Support
*
* This function processes the global actions necessary for remote
* accesses to a global semaphore based on a core mutex. This function
* is called by the core.
+ *
+ * @param[in] the_thread the remote thread the semaphore was surrendered to
+ * @param[in] id is the id of the surrendered semaphore
*/
void _Semaphore_Core_mutex_mp_support (
Thread_Control *the_thread,
@@ -152,11 +155,14 @@ void _Semaphore_Core_mutex_mp_support (
);
/**
- * @brief Semaphore_Core_mp_support
+ * @brief Semaphore Core MP Support
*
* This function processes the global actions necessary for remote
* accesses to a global semaphore based on a core semaphore. This function
* is called by the core.
+ *
+ * @param[in] the_thread the remote thread the semaphore was surrendered to
+ * @param[in] id is the id of the surrendered semaphore
*/
void _Semaphore_Core_semaphore_mp_support (
Thread_Control *the_thread,