UefiCpuPkg: Make the comments align with the functions

[mirror_edk2.git] / UefiCpuPkg / Library / MpInitLib / MpLib.c

diff --git a/UefiCpuPkg/Library/MpInitLib/MpLib.c b/UefiCpuPkg/Library/MpInitLib/MpLib.c
index ed22ce67782ef48b1148b5aac9868b1789a30e50..0495b0f8a4bda8a27273cb7eb078a0c33fbdfd1d 100644 (file)
--- a/UefiCpuPkg/Library/MpInitLib/MpLib.c
+++ b/UefiCpuPkg/Library/MpInitLib/MpLib.c
@@ -337,8 +337,8 @@ ApInitializeSync (
 /**\r
   Find the current Processor number by APIC ID.\r
 \r
 /**\r
   Find the current Processor number by APIC ID.\r
 \r

-  @param[in] CpuMpData         Pointer to PEI CPU MP Data\r
-  @param[in] ProcessorNumber   Return the pocessor number found\r
+  @param[in]  CpuMpData         Pointer to PEI CPU MP Data\r
+  @param[out] ProcessorNumber   Return the pocessor number found\r

 \r
   @retval EFI_SUCCESS          ProcessorNumber is found and returned.\r
   @retval EFI_NOT_FOUND        ProcessorNumber is not found.\r
 \r
   @retval EFI_SUCCESS          ProcessorNumber is found and returned.\r
   @retval EFI_NOT_FOUND        ProcessorNumber is not found.\r


@@ -420,12 +420,13 @@ CollectProcessorCount (
   return CpuMpData->CpuCount;\r
 }\r
 \r
   return CpuMpData->CpuCount;\r
 }\r
 \r

-/*\r
+/**\r

   Initialize CPU AP Data when AP is wakeup at the first time.\r
 \r
   @param[in, out] CpuMpData        Pointer to PEI CPU MP Data\r
   @param[in]      ProcessorNumber  The handle number of processor\r
   @param[in]      BistData         Processor BIST data\r
   Initialize CPU AP Data when AP is wakeup at the first time.\r
 \r
   @param[in, out] CpuMpData        Pointer to PEI CPU MP Data\r
   @param[in]      ProcessorNumber  The handle number of processor\r
   @param[in]      BistData         Processor BIST data\r

+  @param[in]      ApTopOfStack     Top of AP stack\r

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


@@ -1706,7 +1707,7 @@ MpInitLibGetNumberOfProcessors (
                                       simultaneously.\r
   @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                       service.\r
                                       simultaneously.\r
   @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                       service.\r

-  @param[in]  TimeoutInMicrosecsond   Indicates the time limit in microseconds for\r
+  @param[in]  TimeoutInMicroseconds   Indicates the time limit in microseconds for\r

                                       APs to return from Procedure, either for\r
                                       blocking or non-blocking mode.\r
   @param[in]  ProcedureArgument       The parameter passed into Procedure for\r
                                       APs to return from Procedure, either for\r
                                       blocking or non-blocking mode.\r
   @param[in]  ProcedureArgument       The parameter passed into Procedure for\r


@@ -1860,7 +1861,7 @@ StartupAllAPsWorker (
   @param[in]  ProcessorNumber         The handle number of the AP.\r
   @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                       service.\r
   @param[in]  ProcessorNumber         The handle number of the AP.\r
   @param[in]  WaitEvent               The event created by the caller with CreateEvent()\r
                                       service.\r

-  @param[in]  TimeoutInMicrosecsond   Indicates the time limit in microseconds for\r
+  @param[in]  TimeoutInMicroseconds   Indicates the time limit in microseconds for\r

                                       APs to return from Procedure, either for\r
                                       blocking or non-blocking mode.\r
   @param[in]  ProcedureArgument       The parameter passed into Procedure for\r
                                       APs to return from Procedure, either for\r
                                       blocking or non-blocking mode.\r
   @param[in]  ProcedureArgument       The parameter passed into Procedure for\r