Refine comments and two code style.

[mirror_edk2.git] / ShellPkg / Include / Protocol / EfiShellEnvironment2.h

diff --git a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
index ad0b551b96ea6b55cfe7030a7a651cdbf77aebcd..05ec69d5ac02e0ab6f9e6e9c21860c3fec711c8f 100644 (file)
--- a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
+++ b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h
@@ -61,7 +61,7 @@ EFI_STATUS
   This is used when programatically adding shell commands.  Upon successful return\r
   the memory allocated is up to the caller to free.\r
 \r
   This is used when programatically adding shell commands.  Upon successful return\r
   the memory allocated is up to the caller to free.\r
 \r

-  @param[in,out] Str              Pointer to pointer to string to display for help.\r
+  @param[in, out] Str              Pointer to pointer to string to display for help.\r

 \r
   @retval EFI_SUCCESS             The help string is in the parameter Str.\r
 \r
 \r
   @retval EFI_SUCCESS             The help string is in the parameter Str.\r
 \r


@@ -270,9 +270,9 @@ CHAR16*
   The memory allocated by the callee for this list is freed by making a call to\r
   SHELLENV_FREE_FILE_LIST.\r
 \r
   The memory allocated by the callee for this list is freed by making a call to\r
   SHELLENV_FREE_FILE_LIST.\r
 \r

-  @param[in] Arg                The pointer Path to files to open.\r
-  @param[in,out] ListHead       The pointer to the allocated and initialized list head\r
-                                upon which to append all opened file structures.\r
+  @param[in] Arg                 The pointer Path to files to open.\r
+  @param[in, out] ListHead       The pointer to the allocated and initialized list head\r
+                                 upon which to append all opened file structures.\r

 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r
 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r


@@ -289,7 +289,7 @@ EFI_STATUS
 /**\r
   This frees all of the nodes under the ListHead, but not ListHead itself.\r
 \r
 /**\r
   This frees all of the nodes under the ListHead, but not ListHead itself.\r
 \r

-  @param[in,out] ListHead       Pointer to list to free all nodes of.\r
+  @param[in, out] ListHead       Pointer to list to free all nodes of.\r

 \r
   @retval EFI_SUCCESS           This function always returns EFI_SUCCESS.\r
 **/\r
 \r
   @retval EFI_SUCCESS           This function always returns EFI_SUCCESS.\r
 **/\r


@@ -473,12 +473,12 @@ BOOLEAN
   This is an internal shell function to handle shell cascading.  It restores the\r
   original set of console protocols.\r
 \r
   This is an internal shell function to handle shell cascading.  It restores the\r
   original set of console protocols.\r
 \r

-  @param[in] ConInHandle        The handle of ConIn.\r
-  @param[in,out] ConIn          The pointer to the location to return the pointer to\r
-                                the original console input.\r
-  @param[in] ConOutHandle       The handle of ConOut\r
-  @param[in,out] ConOut         The pointer to the location to return the pointer to\r
-                                the original console output.\r
+  @param[in] ConInHandle         The handle of ConIn.\r
+  @param[in, out] ConIn          The pointer to the location to return the pointer to\r
+                                 the original console input.\r
+  @param[in] ConOutHandle        The handle of ConOut\r
+  @param[in, out] ConOut         The pointer to the location to return the pointer to\r
+                                 the original console output.\r

 **/\r
 typedef\r
 VOID\r
 **/\r
 typedef\r
 VOID\r


@@ -512,8 +512,8 @@ VOID
 \r
   This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.\r
 \r
 \r
   This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR.\r
 \r

-  @param[in,out] Handle         The pointer to pointer to Handle.  It is set\r
-                                on a sucessful return.\r
+  @param[in, out] Handle         The pointer to pointer to Handle.  It is set\r
+                                 on a sucessful return.\r

 \r
   @retval EFI_SUCCESS           The next handle in the handle database is *Handle.\r
   @retval EFI_NOT_FOUND         There is not another handle.\r
 \r
   @retval EFI_SUCCESS           The next handle in the handle database is *Handle.\r
   @retval EFI_NOT_FOUND         There is not another handle.\r


@@ -656,7 +656,7 @@ VOID
   This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be\r
   called after INIT_PROTOCOL_INFO_ENUMERATOR.\r
 \r
   This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be\r
   called after INIT_PROTOCOL_INFO_ENUMERATOR.\r
 \r

-  @param[in,out] ProtocolInfo   The pointer to pointer to protocol information structure.\r
+  @param[in, out] ProtocolInfo   The pointer to pointer to protocol information structure.\r

 \r
   @retval EFI_SUCCESS           The next protocol's information was sucessfully returned.\r
   @retval NULL                  There are no more protocols.\r
 \r
   @retval EFI_SUCCESS           The next protocol's information was sucessfully returned.\r
   @retval NULL                  There are no more protocols.\r


@@ -744,15 +744,15 @@ typedef struct {
 \r
   Upon successful return, the memory for *BestDeviceName is up to the caller to free.\r
 \r
 \r
   Upon successful return, the memory for *BestDeviceName is up to the caller to free.\r
 \r

-  @param[in] DeviceHandle           The device handle whose name is desired.\r
-  @param[in] UseComponentName       Whether to use the ComponentName protocol at all.\r
-  @param[in] UseDevicePath          Whether to use the DevicePath protocol at all.\r
-  @param[in] Language               The pointer to the language string to use.\r
-  @param[in,out] BestDeviceName     The pointer to pointer to string allocated with the name.\r
-  @param[out] ConfigurationStatus   The pointer to status for opening a Configuration protocol.\r
-  @param[out] DiagnosticsStatus     The pointer to status for opening a Diagnostics protocol.\r
-  @param[in] Display                Whether to Print this out to default Print location.\r
-  @param[in] Indent                 How many characters to indent the printing.\r
+  @param[in] DeviceHandle            The device handle whose name is desired.\r
+  @param[in] UseComponentName        Whether to use the ComponentName protocol at all.\r
+  @param[in] UseDevicePath           Whether to use the DevicePath protocol at all.\r
+  @param[in] Language                The pointer to the language string to use.\r
+  @param[in, out] BestDeviceName     The pointer to pointer to string allocated with the name.\r
+  @param[out] ConfigurationStatus    The pointer to status for opening a Configuration protocol.\r
+  @param[out] DiagnosticsStatus      The pointer to status for opening a Diagnostics protocol.\r
+  @param[in] Display                 Whether to Print this out to default Print location.\r
+  @param[in] Indent                  How many characters to indent the printing.\r

 \r
   @retval EFI_SUCCESS           This function always returns EFI_SUCCESS.\r
 **/\r
 \r
   @retval EFI_SUCCESS           This function always returns EFI_SUCCESS.\r
 **/\r


@@ -849,9 +849,9 @@ EFI_STATUS
   The memory allocated by the callee for this list is freed by making a call to\r
   SHELLENV_FREE_FILE_LIST.\r
 \r
   The memory allocated by the callee for this list is freed by making a call to\r
   SHELLENV_FREE_FILE_LIST.\r
 \r

-  @param[in] Arg                The pointer to the path of the files to be opened.\r
-  @param[in,out] ListHead       The pointer to allocated and initialized list head\r
-                                upon which to append all the opened file structures.\r
+  @param[in] Arg                 The pointer to the path of the files to be opened.\r
+  @param[in, out] ListHead       The pointer to allocated and initialized list head\r
+                                 upon which to append all the opened file structures.\r

 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r
 \r
   @retval EFI_SUCCESS           One or more files was opened and a struct of each file's\r
                                 information was appended to ListHead.\r