From 1204de7b50926b01394fefb28a04072305a39ca1 Mon Sep 17 00:00:00 2001 From: Vishal Oliyil Kunnil Date: Mon, 19 Aug 2024 14:05:57 -0700 Subject: [PATCH] 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 --- EmbeddedPkg/Library/PrePiHobLib/Hob.c | 17 +++++------------ 1 file changed, 5 insertions(+), 12 deletions(-) diff --git a/EmbeddedPkg/Library/PrePiHobLib/Hob.c b/EmbeddedPkg/Library/PrePiHobLib/Hob.c index cbc35152cc..c6a89e8ad6 100644 --- a/EmbeddedPkg/Library/PrePiHobLib/Hob.c +++ b/EmbeddedPkg/Library/PrePiHobLib/Hob.c @@ -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 - - @return The Boot Mode. + @retval BootMode **/ 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 - PHIT HOB in HOB list. + @param BootMode The value of the boot mode to set. - @param VOID - - @return The Boot Mode. + @retval EFI_SUCCESS The value was successfully updated **/ EFI_STATUS