summaryrefslogtreecommitdiff
path: root/MdePkg/Library/BaseLib/LongJump.c
diff options
context:
space:
mode:
Diffstat (limited to 'MdePkg/Library/BaseLib/LongJump.c')
-rw-r--r--MdePkg/Library/BaseLib/LongJump.c11
1 files changed, 6 insertions, 5 deletions
diff --git a/MdePkg/Library/BaseLib/LongJump.c b/MdePkg/Library/BaseLib/LongJump.c
index e20444b86d..958e850d12 100644
--- a/MdePkg/Library/BaseLib/LongJump.c
+++ b/MdePkg/Library/BaseLib/LongJump.c
@@ -20,16 +20,17 @@
/**
Restores the CPU context that was saved with SetJump().
- Restores the CPU context from the buffer specified by JumpBuffer.
- This function never returns to the caller.
- Instead is resumes execution based on the state of JumpBuffer.
+ Restores the CPU context from the buffer specified by JumpBuffer. This
+ function never returns to the caller. Instead is resumes execution based on
+ the state of JumpBuffer.
If JumpBuffer is NULL, then ASSERT().
For IPF CPUs, if JumpBuffer is not aligned on a 16-byte boundary, then ASSERT().
If Value is 0, then ASSERT().
- @param JumpBuffer A pointer to CPU context buffer.
- @param Value The value to return when the SetJump() context is restored.
+ @param JumpBuffer A pointer to CPU context buffer.
+ @param Value The value to return when the SetJump() context is
+ restored and must be non-zero.
**/
VOID