MdeModulePkg/UefiBootManagerLib: fix AddLoadOptionVariable docs/prototype

Clean up the leading comment and the prototype of
EfiBootManagerAddLoadOptionVariable():

- the function may modify Option on output, annotate the parameter with
  OUT and update the documentation;

- "@retval EFI_STATUS" and "@retval Others" are not idiomatic
  documentation, use @return instead;

- sync comment and prototype between lib instance and lib class header.

Change-Id: I8a609d6502b6f8929b2f568acaa147065003b6f4
Cc: Eric Dong <eric.dong@intel.com>
Cc: Ruiyu Ni <ruiyu.ni@intel.com>
Cc: Star Zeng <star.zeng@intel.com>
Contributed-under: TianoCore Contribution Agreement 1.1
Signed-off-by: Laszlo Ersek <lersek@redhat.com>
Reviewed-by: Ruiyu Ni <ruiyu.ni@intel.com>

1 files changed, 8 insertions, 4 deletions

diff --git a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
index 32918caf32..f88f8e0245 100644
--- a/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
+++ b/MdeModulePkg/Library/UefiBootManagerLib/BmLoadOption.c
@@ -329,7 +329,11 @@ BmAddOptionNumberToOrderVariable (
   This function will register the new Boot####, Driver#### or SysPrep#### option.

   After the *#### is updated, the *Order will also be updated.

 

-  @param  Option            Pointer to load option to add.

+  @param  Option            Pointer to load option to add. If on input

+                            Option->OptionNumber is LoadOptionNumberUnassigned,

+                            then on output Option->OptionNumber is updated to

+                            the number of the new Boot####,

+                            Driver#### or SysPrep#### option.

   @param  Position          Position of the new load option to put in the ****Order variable.

 

   @retval EFI_SUCCESS           The *#### have been successfully registered.

@@ -338,14 +342,14 @@ BmAddOptionNumberToOrderVariable (
                                 Note: this API only adds new load option, no replacement support.

   @retval EFI_OUT_OF_RESOURCES  There is no free option number that can be used when the

                                 option number specified in the Option is LoadOptionNumberUnassigned.

-  @retval EFI_STATUS            Return the status of gRT->SetVariable ().

+  @return                       Status codes of gRT->SetVariable ().

 

 **/

 EFI_STATUS

 EFIAPI

 EfiBootManagerAddLoadOptionVariable (

-  IN EFI_BOOT_MANAGER_LOAD_OPTION *Option,

-  IN UINTN                        Position

+  IN OUT EFI_BOOT_MANAGER_LOAD_OPTION *Option,

+  IN     UINTN                        Position

   )

 {

   EFI_STATUS                      Status;