tyler.durden
/
audk
mirror of https://github.com/acidanthera/audk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update the comments in function headers to follow Doxygen special documentation blocks in section 2.3.5. 

Signed-off-by: Shumin Qiu <shumin.qiu@intel.com>
Reviewed-by: Jaben Carsey <Jaben.carsey@intel.com>

git-svn-id: https://svn.code.sf.net/p/edk2/code/trunk/edk2@15163 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
Shumin Qiu 2014-01-23 00:27:52 +00:00 committed by shenshushi
parent 7798fb83de
commit f614ce7ebb
2 changed files with 24 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
ShellPkg/Application/Shell/ShellParametersProtocol.c
View File

@ -570,6 +570,10 @@ FixVarName (
/** /**
Remove the unicode file tag from the begining of the file buffer since that will not be Remove the unicode file tag from the begining of the file buffer since that will not be
used by StdIn. used by StdIn.
@param[in] Handle Pointer to the handle of the file to be processed.
@retval EFI_SUCCESS The unicode file tag has been moved successfully.
**/ **/
EFI_STATUS EFI_STATUS
EFIAPI EFIAPI

30
ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c
View File

@ -1492,6 +1492,7 @@ PciGetNextBusRange (
@param[in] ConfigSpace Data in PCI configuration space. @param[in] ConfigSpace Data in PCI configuration space.
@param[in] Address Address used to access configuration space of this PCI device. @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] IoDev Handle used to access configuration space of PCI device.
@param[in] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The command completed successfully. @retval EFI_SUCCESS The command completed successfully.
**/ **/
@ -1618,11 +1619,12 @@ PciExplainBridgeControl (
/** /**
Print each capability structure. Print each capability structure.
@param[in] IoDev The pointer to the deivce. @param[in] IoDev The pointer to the deivce.
@param[in] Address The address to start at. @param[in] Address The address to start at.
@param[in] CapPtr The offset from the address. @param[in] CapPtr The offset from the address.
@param[in] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The operation was successful. @retval EFI_SUCCESS The operation was successful.
**/ **/
EFI_STATUS EFI_STATUS
PciExplainCapabilityStruct ( PciExplainCapabilityStruct (
@ -1635,9 +1637,13 @@ PciExplainCapabilityStruct (
/** /**
Display Pcie device structure. Display Pcie device structure.
@param[in] IoDev The pointer to the root pci protocol. @param[in] IoDev The pointer to the root pci protocol.
@param[in] Address The Address to start at. @param[in] Address The Address to start at.
@param[in] CapabilityPtr The offset from the address to start. @param[in] CapabilityPtr The offset from the address to start.
@param[in] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The command completed successfully.
@retval @retval EFI_SUCCESS Pci express extend space IO is not suppoted.
**/ **/
EFI_STATUS EFI_STATUS
PciExplainPciExpress ( PciExplainPciExpress (
@ -2660,6 +2666,7 @@ PciGetNextBusRange (
@param[in] ConfigSpace Data in PCI configuration space. @param[in] ConfigSpace Data in PCI configuration space.
@param[in] Address Address used to access configuration space of this PCI device. @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] IoDev Handle used to access configuration space of PCI device.
@param[in] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The command completed successfully. @retval EFI_SUCCESS The command completed successfully.
**/ **/
@ -3790,9 +3797,10 @@ PciExplainBridgeControl (
/** /**
Print each capability structure. Print each capability structure.
@param[in] IoDev The pointer to the deivce. @param[in] IoDev The pointer to the deivce.
@param[in] Address The address to start at. @param[in] Address The address to start at.
@param[in] CapPtr The offset from the address. @param[in] CapPtr The offset from the address.
@param[in] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The operation was successful. @retval EFI_SUCCESS The operation was successful.
**/ **/
@ -5326,6 +5334,8 @@ PrintPciExtendedCapabilityDetails(
@param[in] IoDev The pointer to the root pci protocol. @param[in] IoDev The pointer to the root pci protocol.
@param[in] Address The Address to start at. @param[in] Address The Address to start at.
@param[in] CapabilityPtr The offset from the address to start. @param[in] CapabilityPtr The offset from the address to start.
@param[in] EnhancedDump The print format for the dump data.
**/ **/
EFI_STATUS EFI_STATUS
PciExplainPciExpress ( PciExplainPciExpress (