diff options
| author | gikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-25 03:19:49 +0000 |
|---|---|---|
| committer | gikidy <gikidy@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-11-25 03:19:49 +0000 |
| commit | 9aa049d9717f1260426918eab2d5986e838a8754 (patch) | |
| tree | cb3b25e97e56c0140b2670aa37e131994a2392ab /MdePkg/Library/BaseLib/LongJump.c | |
| parent | 04fdba541287ba2759ce3e51157c38148ad8b4f6 (diff) | |
| download | edk2-9aa049d9717f1260426918eab2d5986e838a8754.tar.gz edk2-9aa049d9717f1260426918eab2d5986e838a8754.tar.bz2 edk2-9aa049d9717f1260426918eab2d5986e838a8754.zip | |
Synchronize function comment in MdePkg\Library\BaseLib.h with the instance of this functions.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6718 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Library/BaseLib/LongJump.c')
| -rw-r--r-- | MdePkg/Library/BaseLib/LongJump.c | 11 |
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
|