diff options
| author | Vishal Oliyil Kunnil <vishalo@qti.qualcomm.com> | 2024-08-19 14:05:57 -0700 |
|---|---|---|
| committer | mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> | 2024-09-05 17:08:51 +0000 |
| commit | 1204de7b50926b01394fefb28a04072305a39ca1 (patch) | |
| tree | 28daefc4362274a6629081c1c188ed4368322180 /EmbeddedPkg | |
| parent | 3151798123e1419e74ebef1df73e9d651f1fcd3e (diff) | |
| download | edk2-1204de7b50926b01394fefb28a04072305a39ca1.tar.gz | |
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>
Diffstat (limited to 'EmbeddedPkg')
| -rw-r--r-- | EmbeddedPkg/Library/PrePiHobLib/Hob.c | 17 |
1 files 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 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
|