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/Library/UefiShellDebug1CommandsLib/Bcfg.c | 5 +-- .../Library/UefiShellDebug1CommandsLib/Compress.c | 8 ++--- .../Library/UefiShellDebug1CommandsLib/Compress.h | 10 +++--- .../UefiShellDebug1CommandsLib/Edit/FileBuffer.c | 12 +++---- .../HexEdit/MainHexEditor.c | 5 +-- .../UefiShellDebug1CommandsLib/HexEdit/MemImage.c | 20 +++++------ ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c | 42 +++++++++++----------- .../SmbiosView/LibSmbiosView.c | 8 ++--- .../SmbiosView/LibSmbiosView.h | 8 ++--- .../SmbiosView/PrintInfo.c | 6 ++-- .../SmbiosView/QueryTable.c | 10 +++--- .../SmbiosView/QueryTable.h | 10 +++--- .../UefiShellDebug1CommandsLib.c | 8 ++--- .../UefiShellDebug1CommandsLib.h | 8 ++--- 14 files changed, 81 insertions(+), 79 deletions(-) (limited to 'ShellPkg/Library/UefiShellDebug1CommandsLib') diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c index 24926a8e9a..de2ce2bfc3 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Bcfg.c @@ -49,8 +49,9 @@ typedef struct { /** This function will populate the device path protocol parameter based on TheHandle. - - @param[in,out] DevPath On a sucessful return the device path to the handle. + + @param[in] TheHandle Driver handle. + @param[in, out] FilePath On a sucessful return the device path to the handle. @retval EFI_SUCCESS The device path was sucessfully returned. @retval other A error from gBS->HandleProtocol. diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c index 01321d1ed6..06a3210ea0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.c @@ -1324,10 +1324,10 @@ Encode ( /** The compression routine. - @param[in] SrcBuffer The buffer containing the source data. - @param[in] SrcSize The number of bytes in SrcBuffer. - @param[in] DstBuffer The buffer to put the compressed image in. - @param[in,out] DstSize On input the size (in bytes) of DstBuffer, on + @param[in] SrcBuffer The buffer containing the source data. + @param[in] SrcSize The number of bytes in SrcBuffer. + @param[in] DstBuffer The buffer to put the compressed image in. + @param[in, out] DstSize On input the size (in bytes) of DstBuffer, on return the number of bytes placed in DstBuffer. @retval EFI_SUCCESS The compression was sucessful. diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h index 64e339cf97..39a997178f 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Compress.h @@ -18,11 +18,11 @@ /** The compression routine. - @param[in] SrcBuffer The buffer containing the source data. - @param[in] SrcSize Number of bytes in SrcBuffer. - @param[in] DstBuffer The buffer to put the compressed image in. - @param[in,out] DstSize On input the size (in bytes) of DstBuffer, on - return the number of bytes placed in DstBuffer. + @param[in] SrcBuffer The buffer containing the source data. + @param[in] SrcSize Number of bytes in SrcBuffer. + @param[in] DstBuffer The buffer to put the compressed image in. + @param[in, out] DstSize On input the size (in bytes) of DstBuffer, on + return the number of bytes placed in DstBuffer. @retval EFI_SUCCESS The compression was sucessful. @retval EFI_BUFFER_TOO_SMALL The buffer was too small. DstSize is required. diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c index ba622983e1..7d82884326 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Edit/FileBuffer.c @@ -1685,8 +1685,8 @@ FileBufferScrollLeft ( /** Delete a char in line - @param[in,out] Line The line to delete in. - @param[in] Pos Position to delete the char at ( start from 0 ). + @param[in, out] Line The line to delete in. + @param[in] Pos Position to delete the char at ( start from 0 ). **/ VOID EFIAPI @@ -1710,8 +1710,8 @@ LineDeleteAt ( /** Concatenate Src into Dest. - @param[in,out] Dest Destination string - @param[in] Src Src String. + @param[in, out] Dest Destination string + @param[in] Src Src String. **/ VOID EFIAPI @@ -2981,7 +2981,7 @@ FileBufferSearch ( // // found // - if (Found == TRUE) { + if (Found) { Column = (Position - 1) + FileBuffer.FilePosition.Column + Offset; Row = FileBuffer.FilePosition.Row; } else { @@ -3000,7 +3000,7 @@ FileBufferSearch ( Found = TRUE; } - if (Found == TRUE) { + if (Found) { // // found // diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c index 3602a72433..808f7a56c0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MainHexEditor.c @@ -106,10 +106,11 @@ HMainCommandDisplayHelp ( VOID ) { - INT32 CurrentLine=0; + INT32 CurrentLine; CHAR16 * InfoString; EFI_INPUT_KEY Key; - + + CurrentLine = 0; // print helpInfo for (CurrentLine = 0; 0 != HexMainMenuHelpInfo[CurrentLine]; CurrentLine++) { InfoString = HiiGetString(gShellDebug1HiiHandle, HexMainMenuHelpInfo[CurrentLine] diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c index f327c5aede..9d44abddd7 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/HexEdit/MemImage.c @@ -41,11 +41,11 @@ HEFI_EDITOR_MEM_IMAGE HMemImageConst = { /** Empty function. always returns the same. - @param[in] This Ignored. - @param[in] Width Ignored. - @param[in] Address Ignored. - @param[in] Count Ignored. - @param[in,out] Buffer Ignored. + @param[in] This Ignored. + @param[in] Width Ignored. + @param[in] Address Ignored. + @param[in] Count Ignored. + @param[in, out] Buffer Ignored. @retval EFI_UNSUPPORTED. **/ @@ -65,11 +65,11 @@ DummyMemRead ( /** Empty function. always returns the same. - @param[in] This Ignored. - @param[in] Width Ignored. - @param[in] Address Ignored. - @param[in] Count Ignored. - @param[in,out] Buffer Ignored. + @param[in] This Ignored. + @param[in] Width Ignored. + @param[in] Address Ignored. + @param[in] Count Ignored. + @param[in, out] Buffer Ignored. @retval EFI_UNSUPPORTED. **/ diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c index 3f4147f9a1..e597bbc6b0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c @@ -1268,7 +1268,7 @@ PCI_CLASS_ENTRY PCIPIFClass_0e00[] = { bits 23:16 - Base Class Code bits 15:8 - Sub-Class Code bits 7:0 - Programming Interface - @param[in,out] ClassStrings Pointer of PCI_CLASS_STRINGS structure, which contains + @param[in, out] ClassStrings Pointer of PCI_CLASS_STRINGS structure, which contains printable class strings corresponding to ClassCode. The caller must not modify the strings that are pointed by the fields in ClassStrings. @@ -1474,11 +1474,11 @@ PciGetProtocolAndResource ( It also moves the pointer backward a node, to get prepared to be called again. - @param[in,out] Descriptors Points to current position of a serial of address space - descriptors. - @param[out] MinBus The lower range of bus number. - @param[out] ManBus The upper range of bus number. - @param[out] IsEnd Meet end of the serial of descriptors. + @param[in, out] Descriptors Points to current position of a serial of address space + descriptors. + @param[out] MinBus The lower range of bus number. + @param[out] MaxBus The upper range of bus number. + @param[out] IsEnd Meet end of the serial of descriptors. @retval EFI_SUCCESS The command completed successfully. **/ @@ -1543,11 +1543,11 @@ PciExplainBridgeData ( /** Explain the Base Address Register(Bar) in PCI configuration space. - @param[in] Bar Points to the Base Address Register intended to interpret. - @param[in] Command Points to the register Command. - @param[in] Address Address used to access configuration space of this PCI device. - @param[in] IoDev Handle used to access configuration space of PCI device. - @param[in,out] Index The Index. + @param[in] Bar Points to the Base Address Register intended to interpret. + @param[in] Command Points to the register Command. + @param[in] Address Address used to access configuration space of this PCI device. + @param[in] IoDev Handle used to access configuration space of PCI device. + @param[in, out] Index The Index. @retval EFI_SUCCESS The command completed successfully. **/ @@ -2564,11 +2564,11 @@ PciGetProtocolAndResource ( It also moves the pointer backward a node, to get prepared to be called again. - @param[in,out] Descriptors Points to current position of a serial of address space - descriptors. - @param[out] MinBus The lower range of bus number. - @param[out] ManBus The upper range of bus number. - @param[out] IsEnd Meet end of the serial of descriptors. + @param[in, out] Descriptors Points to current position of a serial of address space + descriptors. + @param[out] MinBus The lower range of bus number. + @param[out] MaxBus The upper range of bus number. + @param[out] IsEnd Meet end of the serial of descriptors. @retval EFI_SUCCESS The command completed successfully. **/ @@ -3148,11 +3148,11 @@ PciExplainBridgeData ( /** Explain the Base Address Register(Bar) in PCI configuration space. - @param[in] Bar Points to the Base Address Register intended to interpret. - @param[in] Command Points to the register Command. - @param[in] Address Address used to access configuration space of this PCI device. - @param[in] IoDev Handle used to access configuration space of PCI device. - @param[in,out] Index The Index. + @param[in] Bar Points to the Base Address Register intended to interpret. + @param[in] Command Points to the register Command. + @param[in] Address Address used to access configuration space of this PCI device. + @param[in] IoDev Handle used to access configuration space of PCI device. + @param[in, out] Index The Index. @retval EFI_SUCCESS The command completed successfully. **/ diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c index 9e995683d0..ed73a584bd 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.c @@ -104,10 +104,10 @@ LibSmbiosGetEPS ( Handle is changed to the next handle or 0xFFFF when the end is reached or the handle is not found. - @param[in,out] Handle 0xFFFF: get the first structure - Others: get a structure according to this value. - @param[in,out] Buffer The pointer to the caller's memory buffer. - @param[out] Length Length of return buffer in bytes. + @param[in, out] Handle 0xFFFF: get the first structure + Others: get a structure according to this value. + @param[in, out] Buffer The pointer to the caller's memory buffer. + @param[out] Length Length of return buffer in bytes. @retval DMI_SUCCESS Buffer contains the required structure data Handle is updated with next structure handle or diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h index 76442cdf1a..5a9b2ad626 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/LibSmbiosView.h @@ -72,10 +72,10 @@ LibSmbiosGetEPS ( Handle is changed to the next handle or 0xFFFF when the end is reached or the handle is not found. - @param[in,out] Handle 0xFFFF: get the first structure - Others: get a structure according to this value. - @param[in,out] Buffer The pointer to the caller's memory buffer. - @param[out] Length Length of return buffer in bytes. + @param[in, out] Handle 0xFFFF: get the first structure + Others: get a structure according to this value. + @param[in, out] Buffer The pointer to the caller's memory buffer. + @param[out] Length Length of return buffer in bytes. @retval DMI_SUCCESS Buffer contains the required structure data Handle is updated with next structure handle or diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c index 7a7caac456..7c081bdf8a 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/PrintInfo.c @@ -82,9 +82,9 @@ Copy Length of Src buffer to Dest buffer, add a NULL termination to Dest buffer. - @param[in,out] Dest Destination buffer head. - @param[in] Src Source buffer head. - @param[in] Length Length of buffer to be copied. + @param[in, out] Dest Destination buffer head. + @param[in] Src Source buffer head. + @param[in] Length Length of buffer to be copied. **/ VOID MemToString ( diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c index d84ab10c29..64997284b0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.c @@ -2936,11 +2936,11 @@ TABLE_ITEM StructureTypeInfoTable[] = { Then all the Key Value between Low and High gets the same string L"Unused". - @param[in] Table The begin address of table. - @param[in] Number The number of table items. - @param[in] Key The query Key. - @param[in,out] Info Input as empty buffer; output as data buffer. - @param[in] InfoLen The max number of characters for Info. + @param[in] Table The begin address of table. + @param[in] Number The number of table items. + @param[in] Key The query Key. + @param[in, out] Info Input as empty buffer; output as data buffer. + @param[in] InfoLen The max number of characters for Info. @return the found Key and Info is valid. @retval QUERY_TABLE_UNFOUND and Info should be NULL. diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h index 6809820232..5a0c5e05c0 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/SmbiosView/QueryTable.h @@ -52,11 +52,11 @@ typedef struct TABLE_ITEM { Then all the Key Value between Low and High gets the same string L"Unused". - @param[in] Table The begin address of table. - @param[in] Number The number of table items. - @param[in] Key The query Key. - @param[in,out] Info Input as empty buffer; output as data buffer. - @param[in] InfoLen The max number of characters for Info. + @param[in] Table The begin address of table. + @param[in] Number The number of table items. + @param[in] Key The query Key. + @param[in, out] Info Input as empty buffer; output as data buffer. + @param[in] InfoLen The max number of characters for Info. @return the found Key and Info is valid. @retval QUERY_TABLE_UNFOUND and Info should be NULL. diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c index f3cc8d9ce9..b54d8e1f28 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.c @@ -226,8 +226,8 @@ CharToUpper ( Function returns a system configuration table that is stored in the EFI System Table based on the provided GUID. - @param[in] TableGuid A pointer to the table's GUID type. - @param[in,out] Table On exit, a pointer to a system configuration table. + @param[in] TableGuid A pointer to the table's GUID type. + @param[in, out] Table On exit, a pointer to a system configuration table. @retval EFI_SUCCESS A configuration table matching TableGuid was found. @retval EFI_NOT_FOUND A configuration table matching TableGuid was not found. @@ -281,8 +281,8 @@ HexCharToUintn ( /** Convert a string representation of a guid to a Guid value. - @param[in] StringGuid The pointer to the string of a guid. - @param[in,out] Guid The pointer to the GUID structure to populate. + @param[in] StringGuid The pointer to the string of a guid. + @param[in, out] Guid The pointer to the GUID structure to populate. @retval EFI_INVALID_PARAMETER A parameter was invalid. @retval EFI_SUCCESS The conversion was successful. diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h index 3db03c8fab..7cabfe3278 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/UefiShellDebug1CommandsLib.h @@ -82,8 +82,8 @@ DumpHex ( Function returns a system configuration table that is stored in the EFI System Table based on the provided GUID. - @param[in] TableGuid A pointer to the table's GUID type. - @param[in,out] Table On exit, a pointer to a system configuration table. + @param[in] TableGuid A pointer to the table's GUID type. + @param[in, out] Table On exit, a pointer to a system configuration table. @retval EFI_SUCCESS A configuration table matching TableGuid was found. @retval EFI_NOT_FOUND A configuration table matching TableGuid was not found. @@ -98,8 +98,8 @@ GetSystemConfigurationTable ( /** Convert a string representation of a GUID to the GUID value. - @param[in] StringGuid The pointer to the string containing a GUID printed. - @param[in,out] Guid The pointer to the buffer to get the GUID value. + @param[in] StringGuid The pointer to the string containing a GUID printed. + @param[in, out] Guid The pointer to the buffer to get the GUID value. **/ EFI_STATUS EFIAPI -- cgit v1.2.3