clean up the un-suitable ';' location when declaring the functions.

[mirror_edk2.git] / IntelFrameworkModulePkg / Bus / Pci / PciBusDxe / PciDriverOverride.h

diff --git a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.h b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.h
index 013d74a9ddb11d04cf69b85cc95e51d926805ba8..318df6045c27153345eb824035b67310d8c22006 100644 (file)
--- a/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/PciBusDxe/PciDriverOverride.h
@@ -27,73 +27,48 @@ typedef struct {
 #define DRIVER_OVERRIDE_FROM_LINK(a) \\r
   CR (a, PCI_DRIVER_OVERRIDE_LIST, Link, DRIVER_OVERRIDE_SIGNATURE)\r
 \r
+/**\r
+  Initializes a PCI Driver Override Instance\r
+\r
+  @param  PciIoDevice   Device instance\r
 \r
+  @retval EFI_SUCCESS Operation success\r
+**/\r
 EFI_STATUS\r
 InitializePciDriverOverrideInstance (\r
   PCI_IO_DEVICE  *PciIoDevice\r
-  )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  PciIoDevice - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
+  );\r
 \r
+/**\r
+  Add an overriding driver image\r
+  \r
+  @param PciIoDevice        Instance of PciIo device\r
+  @param DriverImageHandle  new added driver image\r
+  \r
+  @retval EFI_OUT_OF_RESOURCES no memory resource for new driver instance\r
+  @retval EFI_SUCCESS       Success add driver\r
 **/\r
-;\r
-\r
 EFI_STATUS\r
 AddDriver (\r
   IN PCI_IO_DEVICE     *PciIoDevice,\r
   IN EFI_HANDLE        DriverImageHandle\r
-  )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
+  );\r
 \r
-Arguments:\r
-\r
-  PciIoDevice       - TODO: add argument description\r
-  DriverImageHandle - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
 \r
+/**\r
+  Get a overriding driver image\r
+  @param  This                Pointer to instance of EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL\r
+  @param  DriverImageHandle   Override driver image,\r
+  \r
+  @retval EFI_SUCCESS                 Success to get driver image handle\r
+  @retval EFI_NOT_FOUND               can not find override driver image\r
+  @retval EFI_INVALID_PARAMETER       Invalid parameter\r
 **/\r
-;\r
-\r
 EFI_STATUS\r
 EFIAPI\r
 GetDriver (\r
   IN EFI_BUS_SPECIFIC_DRIVER_OVERRIDE_PROTOCOL              *This,\r
   IN OUT EFI_HANDLE                                         *DriverImageHandle\r
-  )\r
-/**\r
-\r
-Routine Description:\r
-\r
-  TODO: Add function description\r
-\r
-Arguments:\r
-\r
-  This              - TODO: add argument description\r
-  DriverImageHandle - TODO: add argument description\r
-\r
-Returns:\r
-\r
-  TODO: add return values\r
-\r
-**/\r
-;\r
+  );\r
 \r
 #endif\r