[rtems commit] threadqextractwithproxy.c: Doxygen header and spacing

[Joel Sherrill]

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

Author:    Joel Sherrill <joel.sherrill at oarcorp.com>
Date:      Wed Oct 10 16:44:14 2012 -0500

threadqextractwithproxy.c: Doxygen header and spacing

---

 cpukit/score/src/threadqextractwithproxy.c |   29 +++++++++++++--------------
 1 files changed, 14 insertions(+), 15 deletions(-)

diff --git a/cpukit/score/src/threadqextractwithproxy.c b/cpukit/score/src/threadqextractwithproxy.c
index 6b17adb..7c8b84b 100644
--- a/cpukit/score/src/threadqextractwithproxy.c
+++ b/cpukit/score/src/threadqextractwithproxy.c
@@ -1,8 +1,17 @@
-/*
- *  Thread Queue Handler
- *
+/**
+ *  @brief _Thread_queue_Extract_with_proxy
  *
- *  COPYRIGHT (c) 1989-2008.
+ *  This routine extracts the_thread from the_thread_queue
+ *  and ensures that if there is a proxy for this task on
+ *  another node, it is also dealt with. A proxy is a data
+ *  data that is on the thread queue on the remote node and
+ *  acts as a proxy for the local thread. If the local thread
+ *  was waiting on a remote operation, then the remote side
+ *  of the operation must be cleaned up.
+ */
+
+/*
+ *  COPYRIGHT (c) 1989-2012.
  *  On-Line Applications Research Corporation (OAR).
  *
  *  The license and distribution terms for this file may be
@@ -23,21 +32,11 @@
 #include <rtems/score/threadq.h>
 #include <rtems/score/tqdata.h>
 
-/*
- *  _Thread_queue_Extract_with_proxy
- *
- *  This routine extracts the_thread from the_thread_queue
- *  and ensures that if there is a proxy for this task on
- *  another node, it is also dealt with.
- *
- *  XXX
- */
-
 bool _Thread_queue_Extract_with_proxy(
   Thread_Control       *the_thread
 )
 {
-  States_Control                state;
+  States_Control        state;
 
   state = the_thread->current_state;