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

diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c
index 4a4925afe5669d1b1646c8972c3e724d7b895bc3..b1c6923035a873e40e1f8235ff86b5bfd806358d 100644 (file)
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.c
@@ -61,8 +61,11 @@ InternalPrintMessage (
 /**\r
   Find and display image base address and return image base and its entry point.\r
   \r
 /**\r
   Find and display image base address and return image base and its entry point.\r
   \r

-  @return EFI_SUCCESS     Image base address.\r
-  @return 0               Image header cannot be found.\r
+  @param CurrentEip      Current instruction pointer.\r
+  @param EntryPoint      Return module entry point if module header is found.\r
+  \r
+  @return !0     Image base address.\r
+  @return 0      Image header cannot be found.\r

 **/\r
 UINTN \r
 FindModuleImageBase (\r
 **/\r
 UINTN \r
 FindModuleImageBase (\r

diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h
index fa245e2ac8a4044a12dff6b4498c221ef296938c..66847eaae60239d84b5d5a4b0c459950f3c0b3f4 100644 (file)
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/CpuExceptionCommon.h
@@ -72,8 +72,11 @@ InternalPrintMessage (
 /**\r
   Find and display image base address and return image base and its entry point.\r
   \r
 /**\r
   Find and display image base address and return image base and its entry point.\r
   \r

-  @return EFI_SUCCESS     Image base address.\r
-  @return 0               Image header cannot be found.\r
+  @param CurrentEip      Current instruction pointer.\r
+  @param EntryPoint      Return module entry point if module header is found.\r
+  \r
+  @return !0     Image base address.\r
+  @return 0      Image header cannot be found.\r

 **/\r
 UINTN \r
 FindModuleImageBase (\r
 **/\r
 UINTN \r
 FindModuleImageBase (\r

diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c
index 3110687284080ed01650d379de6462eea919242d..682def43be172ce54db2ef6e9f1652da73d4f20b 100644 (file)
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/DxeSmmCpuException.c
@@ -68,8 +68,8 @@ CommonExceptionHandler (
 \r
   This API will setups the CPU exception handler to display CPU contents and run into\r
   CpuDeadLoop(). \r
 \r
   This API will setups the CPU exception handler to display CPU contents and run into\r
   CpuDeadLoop(). \r

-  @Note: Before invoking this API, caller must allocate memory for IDT table and load \r
-         IDTR by AsmWriteIdtr().\r
+  Note: Before invoking this API, caller must allocate memory for IDT table and load \r
+        IDTR by AsmWriteIdtr().\r

   \r
 **/\r
 VOID\r
   \r
 **/\r
 VOID\r

diff --git a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c
index de76e478baee365833124939e5da644a07760f09..ebd9fe32b7b7e139d985b3f5d1b9f567939d58a2 100644 (file)
--- a/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c
+++ b/UefiCpuPkg/Library/CpuExceptionHandlerLib/SecPeiCpuException.c
@@ -49,8 +49,8 @@ CommonExceptionHandler (
 \r
   This API will setups the CPU exception handler to display CPU contents and run into\r
   CpuDeadLoop(). \r
 \r
   This API will setups the CPU exception handler to display CPU contents and run into\r
   CpuDeadLoop(). \r

-  @Note: Before invoking this API, caller must allocate memory for IDT table and load \r
-         IDTR by AsmWriteIdtr().\r
+  Note: Before invoking this API, caller must allocate memory for IDT table and load \r
+        IDTR by AsmWriteIdtr().\r

   \r
 **/\r
 VOID\r
   \r
 **/\r
 VOID\r