summaryrefslogtreecommitdiff
path: root/UefiCpuPkg
diff options
context:
space:
mode:
authorvanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>2012-03-19 08:58:57 +0000
committervanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>2012-03-19 08:58:57 +0000
commita9c7ab95ead26283970a8569fa3de75c6b584b33 (patch)
tree949152598a9bfb932c2ad1bc8f92ba64f81d39b9 /UefiCpuPkg
parent5aab2d509403352d97809649eaad26f7f44e170c (diff)
downloadedk2-platforms-a9c7ab95ead26283970a8569fa3de75c6b584b33.tar.xz
Fix doxgen format issue.
Signed-off-by: vanjeff git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@13112 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'UefiCpuPkg')
-rw-r--r--UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c7
-rw-r--r--UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h7
-rw-r--r--UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c4
-rw-r--r--UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c4
4 files changed, 14 insertions, 8 deletions
diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c
index 4a4925afe5..b1c6923035 100644
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c
@@ -61,8 +61,11 @@ InternalPrintMessage (
/**
Find and display image base address and return image base and its entry point.
- @return EFI_SUCCESS Image base address.
- @return 0 Image header cannot be found.
+ @param CurrentEip Current instruction pointer.
+ @param EntryPoint Return module entry point if module header is found.
+
+ @return !0 Image base address.
+ @return 0 Image header cannot be found.
**/
UINTN
FindModuleImageBase (
diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h
index fa245e2ac8..66847eaae6 100644
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h
@@ -72,8 +72,11 @@ InternalPrintMessage (
/**
Find and display image base address and return image base and its entry point.
- @return EFI_SUCCESS Image base address.
- @return 0 Image header cannot be found.
+ @param CurrentEip Current instruction pointer.
+ @param EntryPoint Return module entry point if module header is found.
+
+ @return !0 Image base address.
+ @return 0 Image header cannot be found.
**/
UINTN
FindModuleImageBase (
diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c
index 3110687284..682def43be 100644
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c
@@ -68,8 +68,8 @@ CommonExceptionHandler (
This API will setups the CPU exception handler to display CPU contents and run into
CpuDeadLoop().
- @Note: Before invoking this API, caller must allocate memory for IDT table and load
- IDTR by AsmWriteIdtr().
+ Note: Before invoking this API, caller must allocate memory for IDT table and load
+ IDTR by AsmWriteIdtr().
**/
VOID
diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c
index de76e478ba..ebd9fe32b7 100644
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c
@@ -49,8 +49,8 @@ CommonExceptionHandler (
This API will setups the CPU exception handler to display CPU contents and run into
CpuDeadLoop().
- @Note: Before invoking this API, caller must allocate memory for IDT table and load
- IDTR by AsmWriteIdtr().
+ Note: Before invoking this API, caller must allocate memory for IDT table and load
+ IDTR by AsmWriteIdtr().
**/
VOID