Add function doxygen header for PciBus module.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciPowerManagement.c

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c
index 0cbbb368802f9115844f207a3bd7a912367784fb..eb77e517ad735aadf1950fc0f351d52ef834ec14 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciPowerManagement.c
@@ -13,28 +13,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 #include "pcibus.h"\r
 \r
-EFI_STATUS\r
-ResetPowerManagementFeature (\r
-  IN PCI_IO_DEVICE *PciIoDevice\r
-  )\r
 /**\r
-\r
-Routine Description:\r
-\r
   This function is intended to turn off PWE assertion and\r
   put the device to D0 state if the device supports\r
   PCI Power Management.\r
 \r
-Arguments:\r
-\r
-Returns:\r
-  \r
-  None\r
+  @param PciIoDevice  Pci device instance\r
 \r
+  @retval EFI_UNSUPPORTED Device do not support power management\r
+  @retval EFI_SUCCESS     Success\r
 **/\r
-// TODO:    PciIoDevice - add argument and description to function comment\r
-// TODO:    EFI_UNSUPPORTED - add return value to function comment\r
-// TODO:    EFI_SUCCESS - add return value to function comment\r
+EFI_STATUS\r
+ResetPowerManagementFeature (\r
+  IN PCI_IO_DEVICE *PciIoDevice\r
+  )\r
 {\r
   EFI_STATUS  Status;\r
   UINT8       PowerManagementRegBlock;\r
@@ -71,3 +63,4 @@ Returns:
 \r
   return EFI_SUCCESS;\r
 }\r
+\r