StandaloneMmPkg: Fix ECC error 4002 and 9002 in StandaloneMmCore

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>
This commit is contained in:
Sami Mujawar
2020-12-07 11:04:26 +00:00
committed by mergify[bot]
parent 3efc2919d0
commit 84096dccd6

View File

@@ -414,6 +414,15 @@ MmEntryPoint (
DEBUG ((DEBUG_INFO, "MmEntryPoint Done\n")); 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 EFI_STATUS
EFIAPI EFIAPI
MmConfigurationMmNotify ( MmConfigurationMmNotify (
@@ -448,6 +457,12 @@ MmConfigurationMmNotify (
return EFI_SUCCESS; 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 UINTN
GetHobListSize ( GetHobListSize (
IN VOID *HobStart IN VOID *HobStart
@@ -475,12 +490,10 @@ GetHobListSize (
Note: This function is called for both DXE invocation and MMRAM invocation. Note: This function is called for both DXE invocation and MMRAM invocation.
@param ImageHandle The firmware allocated handle for the EFI image. @param HobStart Pointer to the start of the HOB list.
@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.
@retval EFI_SUCCESS Success.
@retval EFI_UNSUPPORTED Unsupported operation.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI