[edk2-devel] [PATCH v1 12/25] StandaloneMmPkg: Fix ECC error 4002 and 9002 in StandaloneMmCore

[Sami Mujawar]

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 at arm.com>
---
 StandaloneMmPkg/Core/StandaloneMmCore.c | 23 +++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

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



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#68576): https://edk2.groups.io/g/devel/message/68576
Mute This Topic: https://groups.io/mt/78836544/1813853
Group Owner: devel+owner at edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [edk2-devel-archive at redhat.com]
-=-=-=-=-=-=-=-=-=-=-=-