Clean up MdePkg source to correct some coding style issues, etc.

[mirror_edk2.git] / MdePkg / Library / BaseLib / Arm / InternalSwitchStack.c

diff --git a/MdePkg/Library/BaseLib/Arm/InternalSwitchStack.c b/MdePkg/Library/BaseLib/Arm/InternalSwitchStack.c
index 0bff206fad1def6debbbcbbd5aa493b4035a7438..3147b28bbbcc0a4940b70d79771c209eedb251cf 100644 (file)
--- a/MdePkg/Library/BaseLib/Arm/InternalSwitchStack.c
+++ b/MdePkg/Library/BaseLib/Arm/InternalSwitchStack.c
@@ -1,7 +1,7 @@
 /** @file\r
   SwitchStack() function for ARM.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation<BR>\r
+  Copyright (c) 2006 - 2010, Intel Corporation<BR>\r
   Portions copyright (c) 2008-2009 Apple Inc. All rights reserved.<BR>\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -15,6 +15,21 @@
 \r
 #include "BaseLibInternals.h"\r
 \r
+/**\r
+  Transfers control to a function starting with a new stack.\r
+\r
+  This internal worker function transfers control to the function\r
+  specified by EntryPoint using the new stack specified by NewStack\r
+  and passing in the parameters specified by Context1 and Context2.\r
+  Context1 and Context2 are optional and may be NULL.\r
+  The function EntryPoint must never return.\r
+\r
+  @param EntryPoint   The pointer to the function to enter.\r
+  @param Context1     The first parameter to pass in.\r
+  @param Context2     The second Parameter to pass in\r
+  @param NewStack     The new Location of the stack\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 InternalSwitchStackAsm (\r