[ros-diffs] [tkreuzer] 36391: fix function description comments

Author: tkreuzer
Date: Sun Sep 21 15:15:15 2008
New Revision: 36391

URL: http://svn.reactos.org/svn/reactos?rev=36391&view=rev
Log:
fix function description comments

Modified:
    branches/ros-amd64-bringup/reactos/ntoskrnl/ke/i386/ctxswitch.S

Modified: branches/ros-amd64-bringup/reactos/ntoskrnl/ke/i386/ctxswitch.S
URL:
http://svn.reactos.org/svn/reactos/branches/ros-amd64-bringup/reactos/ntosk…
==============================================================================
--- branches/ros-amd64-bringup/reactos/ntoskrnl/ke/i386/ctxswitch.S [iso-8859-1]
(original)
+++ branches/ros-amd64-bringup/reactos/ntoskrnl/ke/i386/ctxswitch.S [iso-8859-1] Sun Sep
21 15:15:15 2008
@@ -320,9 +320,12 @@
 .endfunc
 
 /*++
- * KiSwapContextInternal 
- *
+ * KiSwapContextInternal
+ *
+ * \brief
  *     The KiSwapContextInternal routine switches context to another thread.
+ *
+ * BOOLEAN USERCALL KiSwapContextInternal();
  *
  * Params:
  *     ESI - Pointer to the KTHREAD to which the caller wishes to
@@ -330,10 +333,10 @@
  *     EDI - Pointer to the KTHREAD to which the caller wishes to
  *           switch from.
  *
- * Returns:
- *     None.
- *
- * Remarks:
+ * \returns
+ *     APC state.
+ *
+ * \remarks
  *     Absolutely all registers except ESP can be trampled here for maximum code
flexibility.
  *
  *--*/
@@ -589,19 +592,25 @@
 #endif
 .endfunc
 
-/*++
- * KiSwapContext 
- *
+/**
+ * KiSwapContext
+ *
+ * \brief
  *     The KiSwapContext routine switches context to another thread.
  *
- * Params:
- *     TargetThread - Pointer to the KTHREAD to which the caller wishes to
- *                    switch to.
- *
- * Returns:
+ * BOOLEAN FASTCALL
+ * KiSwapContext(PKTHREAD CurrentThread, PKTHREAD TargetThread);
+ *
+ * \param CurrentThread
+ *     Pointer to the KTHREAD of the current thread.
+ *                    
+ * \param TargetThread
+ *     Pointer to the KTHREAD to which the caller wishes to switch to.
+ *
+ * \returns
  *     The WaitStatus of the Target Thread.
  *
- * Remarks:
+ * \remarks
  *     This is a wrapper around KiSwapContextInternal which will save all the
  *     non-volatile registers so that the Internal function can use all of
  *     them. It will also save the old current thread and set the new one.