Merge trunk head (r41474)

[reactos.git] / reactos / ntoskrnl / ke / i386 / ctxswitch.S

diff --git a/reactos/ntoskrnl/ke/i386/ctxswitch.S b/reactos/ntoskrnl/ke/i386/ctxswitch.S
index 2edfb2b..396da64 100644 (file)
--- a/reactos/ntoskrnl/ke/i386/ctxswitch.S
+++ b/reactos/ntoskrnl/ke/i386/ctxswitch.S
@@ -320,20 +320,23 @@ BadThread:
 .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
  *           switch to.
  *     EDI - Pointer to the KTHREAD to which the caller wishes to
  *           switch from.
  *
- * Returns:
- *     None.
+ * \returns
+ *     APC state.
  *
- * Remarks:
+ * \remarks
  *     Absolutely all registers except ESP can be trampled here for maximum code flexibility.
  *
  *--*/
@@ -599,19 +602,25 @@ WrongCpu:
 #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.
+ * BOOLEAN FASTCALL
+ * KiSwapContext(PKTHREAD CurrentThread, PKTHREAD TargetThread);
  *
- * Returns:
+ * \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.