]> git.proxmox.com Git - mirror_edk2.git/commitdiff
StandaloneMmPkg: Fix ECC error 4002 and 9002 in StandaloneMmCore
authorSami Mujawar <sami.mujawar@arm.com>
Mon, 7 Dec 2020 11:04:26 +0000 (11:04 +0000)
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Thu, 7 Jan 2021 11:13:39 +0000 (11:13 +0000)
Bugzilla: 3150 (https://bugzilla.tianocore.org/show_bug.cgi?id=3150)

Add doxygen style function documentation headers to fix the ECC
reported errors:
 - [4002] Function header doesn't exist.
 - [9002] The function headers should follow Doxygen special
   documentation blocks in section 2.3.5.

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>
StandaloneMmPkg/Core/StandaloneMmCore.c

index 7c3aca98779f82511b2442a124b03b1738e27e8c..8388ec289ca8d26cff02960aeeb579f418fba4fe 100644 (file)
@@ -414,6 +414,15 @@ MmEntryPoint (
   DEBUG ((DEBUG_INFO, "MmEntryPoint Done\n"));\r
 }\r
 \r
+/** Register the MM Entry Point provided by the MM Core with the\r
+    MM Configuration protocol.\r
+\r
+  @param [in]  Protocol   Pointer to the protocol.\r
+  @param [in]  Interface  Pointer to the MM Configuration protocol.\r
+  @param [in]  Handle     Handle.\r
+\r
+  @retval EFI_SUCCESS             Success.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 MmConfigurationMmNotify (\r
@@ -448,6 +457,12 @@ MmConfigurationMmNotify (
   return EFI_SUCCESS;\r
 }\r
 \r
+/** Returns the HOB list size.\r
+\r
+  @param [in]  HobStart   Pointer to the start of the HOB list.\r
+\r
+  @retval Size of the HOB list.\r
+**/\r
 UINTN\r
 GetHobListSize (\r
   IN VOID *HobStart\r
@@ -475,12 +490,10 @@ GetHobListSize (
 \r
   Note: This function is called for both DXE invocation and MMRAM invocation.\r
 \r
-  @param  ImageHandle    The firmware allocated handle for the EFI image.\r
-  @param  SystemTable    A pointer to the EFI System Table.\r
-\r
-  @retval EFI_SUCCESS    The entry point is executed successfully.\r
-  @retval Other          Some error occurred when executing this entry point.\r
+  @param  HobStart       Pointer to the start of the HOB list.\r
 \r
+  @retval EFI_SUCCESS             Success.\r
+  @retval EFI_UNSUPPORTED         Unsupported operation.\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r