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 <[email protected]>
coreboot · Sep 5, 2024 · 1204de7 · 1204de7
1 parent 3151798
commit 1204de7
Showing 1 changed file with 5 additions and 12 deletions.
diff --git 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 function returns the system boot mode information from the
-  PHIT HOB in HOB list.
+  This service enables PEIMs to update the boot mode variable.
 
-  @param  VOID
+  @param  BootMode              The value of the boot mode to set.
 
-  @return The Boot Mode.
+  @retval EFI_SUCCESS           The value was successfully updated
 
 **/
 EFI_STATUS