StandaloneMmPkg: Fix ECC error 9002 in StandaloneMmCoreEntryPoint

Bugzilla: 3150 (https://bugzilla.tianocore.org/show_bug.cgi?id=3150)

Fix the ECC reported error "[9002] The function headers should follow
Doxygen special documentation blocks in section 2.3.5 in Comment".

Signed-off-by: Sami Mujawar <sami.mujawar@arm.com>
Acked-by: Jiewen Yao <Jiewen.yao@intel.com>
Acked-by: Ard Biesheuvel <ard.biesheuvel@arm.com>
Reviewed-by: Liming Gao <gaoliming@byosoft.com.cn>

diff --git a/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h b/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h
index 8e39ea16d71d36ca86fb6faca190cc24dbf74249..c44f7066c632fd709108c9092566c98beb30bf63 100644 (file)
--- a/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h
+++ b/StandaloneMmPkg/Include/Library/AArch64/StandaloneMmCoreEntryPoint.h
@@ -140,8 +140,9 @@ LocateStandaloneMmCorePeCoffData (
   Use the boot information passed by privileged firmware to populate a HOB list\r
   suitable for consumption by the MM Core and drivers.\r
 \r
-  @param  CpuDriverEntryPoint    Address of MM CPU driver entrypoint\r
-  @param  PayloadBootInfo        Boot information passed by privileged firmware\r
+  @param  [in, out] CpuDriverEntryPoint   Address of MM CPU driver entrypoint\r
+  @param  [in]      PayloadBootInfo       Boot information passed by privileged\r
+                                          firmware\r
 \r
 **/\r
 VOID *\r
@@ -155,9 +156,11 @@ CreateHobListFromBootInfo (
 /**\r
   The entry point of Standalone MM Foundation.\r
 \r
-  @param  SharedBufAddress  Pointer to the Buffer between SPM and SP.\r
-  @param  cookie1.\r
-  @param  cookie2.\r
+  @param  [in]  SharedBufAddress  Pointer to the Buffer between SPM and SP.\r
+  @param  [in]  SharedBufSize     Size of the shared buffer.\r
+  @param  [in]  cookie1           Cookie 1\r
+  @param  [in]  cookie2           Cookie 2\r
+\r
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c
index 08b12c45bc2937942a85ee66cf1a6d80bfa41e69..e8fb96bd6ebf96c28227bbf34a53a2e0e64aaf2c 100644 (file)
--- a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c
+++ b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/CreateHobList.c
@@ -2,7 +2,7 @@
   Creates HOB during Standalone MM Foundation entry point\r
   on ARM platforms.\r
 \r
-Copyright (c) 2017 - 2018, ARM Ltd. All rights reserved.<BR>\r
+Copyright (c) 2017 - 2021, Arm Ltd. All rights reserved.<BR>\r
 SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
@@ -46,7 +46,9 @@ extern EFI_GUID gEfiArmTfCpuDriverEpDescriptorGuid;
   Use the boot information passed by privileged firmware to populate a HOB list\r
   suitable for consumption by the MM Core and drivers.\r
 \r
-  @param  PayloadBootInfo    Boot information passed by privileged firmware\r
+  @param  [in, out] CpuDriverEntryPoint   Address of MM CPU driver entrypoint\r
+  @param  [in]      PayloadBootInfo       Boot information passed by privileged\r
+                                          firmware\r
 \r
 **/\r
 VOID *\r

diff --git a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c
index 903e32d711921b509a0be45bba5e504f8d5caad0..a4d0dd03210c5fe2525d8db39e96996825d69a45 100644 (file)
--- a/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c
+++ b/StandaloneMmPkg/Library/StandaloneMmCoreEntryPoint/AArch64/StandaloneMmCoreEntryPoint.c
@@ -214,9 +214,10 @@ GetSpmVersion (VOID)
 /**\r
   The entry point of Standalone MM Foundation.\r
 \r
-  @param  SharedBufAddress  Pointer to the Buffer between SPM and SP.\r
-  @param  cookie1.\r
-  @param  cookie2.\r
+  @param  [in]  SharedBufAddress  Pointer to the Buffer between SPM and SP.\r
+  @param  [in]  SharedBufSize     Size of the shared buffer.\r
+  @param  [in]  cookie1           Cookie 1\r
+  @param  [in]  cookie2           Cookie 2\r
 \r
 **/\r
 VOID\r