diff options
| author | Shumin Qiu <shumin.qiu@intel.com> | 2014-01-23 00:27:52 +0000 |
|---|---|---|
| committer | shenshushi <shenshushi@6f19259b-4bc3-4df7-8a09-765794883524> | 2014-01-23 00:27:52 +0000 |
| commit | f614ce7ebb1f131a9cd508048ee1123eef5b30a7 (patch) | |
| tree | f88d5e43cbd94d35dfafb4959489add662bd9fa0 /ShellPkg | |
| parent | 7798fb83de4b2505a8e17457256b113a05d8475c (diff) | |
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
Diffstat (limited to 'ShellPkg')
| -rw-r--r-- | ShellPkg/Application/Shell/ShellParametersProtocol.c | 4 | ||||
| -rw-r--r-- | ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c | 30 |
2 files changed, 24 insertions, 10 deletions
diff --git a/ShellPkg/Application/Shell/ShellParametersProtocol.c b/ShellPkg/Application/Shell/ShellParametersProtocol.c index ab435a126..7809a0e0d 100644 --- a/ShellPkg/Application/Shell/ShellParametersProtocol.c +++ b/ShellPkg/Application/Shell/ShellParametersProtocol.c @@ -570,6 +570,10 @@ FixVarName ( /**
Remove the unicode file tag from the begining of the file buffer since that will not be
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
EFIAPI
diff --git a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c index d07ae1721..470f87006 100644 --- a/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c +++ b/ShellPkg/Library/UefiShellDebug1CommandsLib/Pci.c @@ -1492,6 +1492,7 @@ PciGetNextBusRange ( @param[in] ConfigSpace Data in PCI configuration space.
@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] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The command completed successfully.
**/
@@ -1618,11 +1619,12 @@ PciExplainBridgeControl ( /**
Print each capability structure.
- @param[in] IoDev The pointer to the deivce.
- @param[in] Address The address to start at.
- @param[in] CapPtr The offset from the address.
+ @param[in] IoDev The pointer to the deivce.
+ @param[in] Address The address to start at.
+ @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
PciExplainCapabilityStruct (
@@ -1635,9 +1637,13 @@ PciExplainCapabilityStruct ( /**
Display Pcie device structure.
- @param[in] IoDev The pointer to the root pci protocol.
- @param[in] Address The Address to start at.
- @param[in] CapabilityPtr The offset from the address to start.
+ @param[in] IoDev The pointer to the root pci protocol.
+ @param[in] Address The Address to start at.
+ @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
PciExplainPciExpress (
@@ -2660,6 +2666,7 @@ PciGetNextBusRange ( @param[in] ConfigSpace Data in PCI configuration space.
@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] EnhancedDump The print format for the dump data.
@retval EFI_SUCCESS The command completed successfully.
**/
@@ -3790,9 +3797,10 @@ PciExplainBridgeControl ( /**
Print each capability structure.
- @param[in] IoDev The pointer to the deivce.
- @param[in] Address The address to start at.
- @param[in] CapPtr The offset from the address.
+ @param[in] IoDev The pointer to the deivce.
+ @param[in] Address The address to start at.
+ @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.
**/
@@ -5326,6 +5334,8 @@ PrintPciExtendedCapabilityDetails( @param[in] IoDev The pointer to the root pci protocol.
@param[in] Address The Address to start at.
@param[in] CapabilityPtr The offset from the address to start.
+ @param[in] EnhancedDump The print format for the dump data.
+
**/
EFI_STATUS
PciExplainPciExpress (
|