EmbeddedPkg/PrePiHobLib: Align Doxygen comment between code and header

The Doxygen comment for SetBootMode and GetBootMode in PrePiHobLib/Hob.c
does not match declaration in PrePiLib.h. The C file has it wrong. Align
the text to match the header.

Signed-off-by: Vishal Oliyil Kunnil <quic_vishalo@quicinc.com>
This commit is contained in:
Vishal Oliyil Kunnil 2024-08-19 14:05:57 -07:00 committed by mergify[bot]
parent 3151798123
commit 1204de7b50

View File

@ -333,14 +333,10 @@ GetFirstGuidHob (
} }
/** /**
Get the Boot Mode from the HOB list. This service enables PEIMs to ascertain the present value of the boot mode.
This function returns the system boot mode information from the
PHIT HOB in HOB list.
@param VOID @retval BootMode
@return The Boot Mode.
**/ **/
EFI_BOOT_MODE EFI_BOOT_MODE
@ -356,14 +352,11 @@ GetBootMode (
} }
/** /**
Get the Boot Mode from the HOB list. This service enables PEIMs to update the boot mode variable.
This function returns the system boot mode information from the @param BootMode The value of the boot mode to set.
PHIT HOB in HOB list.
@param VOID @retval EFI_SUCCESS The value was successfully updated
@return The Boot Mode.
**/ **/
EFI_STATUS EFI_STATUS