ShellPkg: Document UpdateArgcArgv returns EFI_INVALID_PARAMETER

ShellParametersProtocol::UpdateArgcArgv() can return
a EFI_INVALID_PARAMETER value. Document it.

Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>
Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com>

diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c
index db5fbc1bafc1f3a5e397f1ba5771309dd9548ff9..7e0c8ce42e110fe3dcb9a4feba957ba4b3365992 100644 (file)
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.c
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c
@@ -1340,7 +1340,9 @@ RestoreStdInStdOutStdErr (
   @param[out] OldArgv                    Pointer to old list of parameters.\r
   @param[out] OldArgc                    Pointer to old number of items in Argv list.\r
 \r
+\r
   @retval   EFI_SUCCESS                 Operation was successful, Argv and Argc are valid.\r
+  @return   EFI_INVALID_PARAMETER       Some parameters are invalid.\r
   @retval   EFI_OUT_OF_RESOURCES        A memory allocation failed.\r
 **/\r
 EFI_STATUS\r

diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.h b/ShellPkg/Application/Shell/ShellParametersProtocol.h
index 717552b53358cd5ef68ff5073240de871e61fb98..c50250696ad1dd90e4ff47537179cd9fba088a0a 100644 (file)
--- a/ShellPkg/Application/Shell/ShellParametersProtocol.h
+++ b/ShellPkg/Application/Shell/ShellParametersProtocol.h
@@ -71,6 +71,7 @@ CleanUpShellParametersProtocol (
   @param[out] OldArgc                   pointer to old number of items in Argv list\r
 \r
   @retval   EFI_SUCCESS                 operation was successful, Argv and Argc are valid\r
+  @return   EFI_INVALID_PARAMETER       some parameters are invalid\r
   @retval   EFI_OUT_OF_RESOURCES        a memory allocation failed.\r
 **/\r
 EFI_STATUS\r