From 4ff7e37b4f7e336a8ecb7080b8f48eef4b52d396 Mon Sep 17 00:00:00 2001 From: ydong10 Date: Fri, 2 Sep 2011 08:05:34 +0000 Subject: Refine comments and two code style. Signed-off-by: ydong10 git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@12263 6f19259b-4bc3-4df7-8a09-765794883524 --- ShellPkg/Include/Protocol/EfiShell.h | 26 ++++++------ ShellPkg/Include/Protocol/EfiShellEnvironment2.h | 52 ++++++++++++------------ 2 files changed, 39 insertions(+), 39 deletions(-) (limited to 'ShellPkg/Include/Protocol') diff --git a/ShellPkg/Include/Protocol/EfiShell.h b/ShellPkg/Include/Protocol/EfiShell.h index 64483c01c2..d36c1f6b17 100644 --- a/ShellPkg/Include/Protocol/EfiShell.h +++ b/ShellPkg/Include/Protocol/EfiShell.h @@ -531,9 +531,9 @@ EFI_STATUS If there are multiple map names they will be semi-colon seperated in the NULL-terminated string. - @param[in,out] DevicePath On entry, points to a device path pointer. On - exit, updates the pointer to point to the - portion of the device path after the mapping. + @param[in, out] DevicePath On entry, points to a device path pointer. On + exit, updates the pointer to point to the + portion of the device path after the mapping. @retval NULL No mapping was found. @retval !=NULL Pointer to NULL-terminated mapping. The buffer @@ -640,10 +640,10 @@ EFI_STATUS according to the rules specified in UEFI Shell 2.0 spec section 3.7.1. Each matching file has an EFI_SHELL_FILE_INFO structure created in a linked list. - @param[in] Path A pointer to the path string. - @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or - EFI_FILE_MODE_WRITE. - @param[in,out] FileList Points to the start of a list of files opened. + @param[in] Path A pointer to the path string. + @param[in] OpenMode Specifies the mode used to open each file, EFI_FILE_MODE_READ or + EFI_FILE_MODE_WRITE. + @param[in, out] FileList Points to the start of a list of files opened. @retval EFI_SUCCESS Create the file list successfully. @return Can't create the file list. @@ -710,9 +710,9 @@ EFI_STATUS current position is increased by the number of bytes returned. If FileHandle is a directory, then an error is returned. - @param[in] FileHandle The opened file handle for read. - @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read. - @param[in,out] Buffer The buffer in which data is read. + @param[in] FileHandle The opened file handle for read. + @param[in] ReadSize On input, the size of Buffer, in bytes. On output, the amount of data read. + @param[in, out] Buffer The buffer in which data is read. @retval EFI_SUCCESS Data was read. @retval EFI_NO_MEDIA The device has no media. @@ -929,9 +929,9 @@ EFI_STATUS Direct writes to opened directories are not supported. - @param[in] FileHandle The opened file handle for writing. - @param[in,out] BufferSize On input, size of Buffer. - @param[in] Buffer The buffer in which data to write. + @param[in] FileHandle The opened file handle for writing. + @param[in, out] BufferSize On input, size of Buffer. + @param[in] Buffer The buffer in which data to write. @retval EFI_SUCCESS Data was written. @retval EFI_UNSUPPORTED Writes to open directory are not supported. diff --git a/ShellPkg/Include/Protocol/EfiShellEnvironment2.h b/ShellPkg/Include/Protocol/EfiShellEnvironment2.h index ad0b551b96..05ec69d5ac 100644 --- 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 the memory allocated is up to the caller to free. - @param[in,out] Str Pointer to pointer to string to display for help. + @param[in, out] Str Pointer to pointer to string to display for help. @retval EFI_SUCCESS The help string is in the parameter Str. @@ -270,9 +270,9 @@ CHAR16* The memory allocated by the callee for this list is freed by making a call to SHELLENV_FREE_FILE_LIST. - @param[in] Arg The pointer Path to files to open. - @param[in,out] ListHead The pointer to the allocated and initialized list head - upon which to append all opened file structures. + @param[in] Arg The pointer Path to files to open. + @param[in, out] ListHead The pointer to the allocated and initialized list head + upon which to append all opened file structures. @retval EFI_SUCCESS One or more files was opened and a struct of each file's information was appended to ListHead. @@ -289,7 +289,7 @@ EFI_STATUS /** This frees all of the nodes under the ListHead, but not ListHead itself. - @param[in,out] ListHead Pointer to list to free all nodes of. + @param[in, out] ListHead Pointer to list to free all nodes of. @retval EFI_SUCCESS This function always returns EFI_SUCCESS. **/ @@ -473,12 +473,12 @@ BOOLEAN This is an internal shell function to handle shell cascading. It restores the original set of console protocols. - @param[in] ConInHandle The handle of ConIn. - @param[in,out] ConIn The pointer to the location to return the pointer to - the original console input. - @param[in] ConOutHandle The handle of ConOut - @param[in,out] ConOut The pointer to the location to return the pointer to - the original console output. + @param[in] ConInHandle The handle of ConIn. + @param[in, out] ConIn The pointer to the location to return the pointer to + the original console input. + @param[in] ConOutHandle The handle of ConOut + @param[in, out] ConOut The pointer to the location to return the pointer to + the original console output. **/ typedef VOID @@ -512,8 +512,8 @@ VOID This must be called after INIT_HANDLE_ENUMERATOR and before CLOSE_HANDLE_ENUMERATOR. - @param[in,out] Handle The pointer to pointer to Handle. It is set - on a sucessful return. + @param[in, out] Handle The pointer to pointer to Handle. It is set + on a sucessful return. @retval EFI_SUCCESS The next handle in the handle database is *Handle. @retval EFI_NOT_FOUND There is not another handle. @@ -656,7 +656,7 @@ VOID This cannot be called after CLOSE_PROTOCOL_INFO_ENUMERATOR, but it must be called after INIT_PROTOCOL_INFO_ENUMERATOR. - @param[in,out] ProtocolInfo The pointer to pointer to protocol information structure. + @param[in, out] ProtocolInfo The pointer to pointer to protocol information structure. @retval EFI_SUCCESS The next protocol's information was sucessfully returned. @retval NULL There are no more protocols. @@ -744,15 +744,15 @@ typedef struct { Upon successful return, the memory for *BestDeviceName is up to the caller to free. - @param[in] DeviceHandle The device handle whose name is desired. - @param[in] UseComponentName Whether to use the ComponentName protocol at all. - @param[in] UseDevicePath Whether to use the DevicePath protocol at all. - @param[in] Language The pointer to the language string to use. - @param[in,out] BestDeviceName The pointer to pointer to string allocated with the name. - @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol. - @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol. - @param[in] Display Whether to Print this out to default Print location. - @param[in] Indent How many characters to indent the printing. + @param[in] DeviceHandle The device handle whose name is desired. + @param[in] UseComponentName Whether to use the ComponentName protocol at all. + @param[in] UseDevicePath Whether to use the DevicePath protocol at all. + @param[in] Language The pointer to the language string to use. + @param[in, out] BestDeviceName The pointer to pointer to string allocated with the name. + @param[out] ConfigurationStatus The pointer to status for opening a Configuration protocol. + @param[out] DiagnosticsStatus The pointer to status for opening a Diagnostics protocol. + @param[in] Display Whether to Print this out to default Print location. + @param[in] Indent How many characters to indent the printing. @retval EFI_SUCCESS This function always returns EFI_SUCCESS. **/ @@ -849,9 +849,9 @@ EFI_STATUS The memory allocated by the callee for this list is freed by making a call to SHELLENV_FREE_FILE_LIST. - @param[in] Arg The pointer to the path of the files to be opened. - @param[in,out] ListHead The pointer to allocated and initialized list head - upon which to append all the opened file structures. + @param[in] Arg The pointer to the path of the files to be opened. + @param[in, out] ListHead The pointer to allocated and initialized list head + upon which to append all the opened file structures. @retval EFI_SUCCESS One or more files was opened and a struct of each file's information was appended to ListHead. -- cgit v1.2.3