From a9c7ab95ead26283970a8569fa3de75c6b584b33 Mon Sep 17 00:00:00 2001 From: vanjeff Date: Mon, 19 Mar 2012 08:58:57 +0000 Subject: [PATCH] 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 --- .../Library/CpuExceptionHandlerLib/CpuExceptionCommon.c | 7 +++++-- .../Library/CpuExceptionHandlerLib/CpuExceptionCommon.h | 7 +++++-- .../Library/CpuExceptionHandlerLib/DxeSmmCpuException.c | 4 ++-- .../Library/CpuExceptionHandlerLib/SecPeiCpuException.c | 4 ++-- 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