]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Add function doxygen header for VgaMiniPort module.
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 17 Apr 2008 02:36:59 +0000 (02:36 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 17 Apr 2008 02:36:59 +0000 (02:36 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5075 6f19259b-4bc3-4df7-8a09-765794883524

IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/ComponentName.c
IntelFrameworkModulePkg/Bus/Pci/VgaMiniPortDxe/VgaMiniPort.c

index d8d55146e0cb09a06926bb58eb1df0fa379e003a..58f9c8c48e12ef4793a83c8b5bf6755d489a1a4e 100644 (file)
@@ -1,5 +1,6 @@
 /** @file\r
-\r
+  Implementation of EFI_COMPONENT_NAME_PROTOCOL for VgaminiPort driver.\r
+  \r
 Copyright (c) 2006 - 2007 Intel Corporation. All rights reserved\r
 This program and the accompanying materials\r
 are licensed and made available under the terms and conditions of the BSD License\r
index 3b4a5e4fe906d81e30be285d0951b060932571d8..2e6f56f0dfcad0db1b70f1e24698a6bc84b02984 100644 (file)
@@ -33,26 +33,20 @@ EFI_DRIVER_BINDING_PROTOCOL gPciVgaMiniPortDriverBinding = {
   NULL\r
 };\r
 \r
-//\r
-// Driver Entry Point\r
-//\r
+/**\r
+  Driver entry point for VgaMiniPort driver.\r
+  \r
+  @param ImageHandle  Driver image handle\r
+  @param SystemTable  Point to EFI_SYSTEM_TABLE\r
+  \r
+  @retval Status of install driver binding protocol.\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 PciVgaMiniPortDriverEntryPoint (\r
   IN EFI_HANDLE         ImageHandle,\r
   IN EFI_SYSTEM_TABLE   *SystemTable\r
   )\r
-/**\r
-\r
-  Routine Description:\r
-    Driver Entry Point.\r
-\r
-  Arguments:\r
-    (Standard EFI Image entry - EFI_IMAGE_ENTRY_POINT)\r
-\r
-  Returns:\r
-    EFI_STATUS\r
-**/\r
 {\r
   return EfiLibInstallDriverBindingComponentName2 (\r
            ImageHandle,\r
@@ -287,13 +281,13 @@ PciVgaMiniPortDriverBindingStop (
 //\r
 \r
 /**\r
-  GC_TODO: Add function description\r
+  Thunk function of EFI_VGA_MINI_PORT_SET_MODE\r
 \r
-  @param  This             GC_TODO: add argument description\r
-  @param  ModeNumber       GC_TODO: add argument description\r
+  @param  This             Point to instance of EFI_VGA_MINI_PORT_PROTOCOL\r
+  @param  ModeNumber       Mode number\r
 \r
-  @retval EFI_UNSUPPORTED  GC_TODO: Add description for return value\r
-  @retval EFI_SUCCESS      GC_TODO: Add description for return value\r
+  @retval EFI_UNSUPPORTED  Invalid mode number\r
+  @retval EFI_SUCCESS      Success\r
 \r
 **/\r
 EFI_STATUS\r
@@ -309,3 +303,4 @@ PciVgaMiniPortSetMode (
 \r
   return EFI_SUCCESS;\r
 }\r
+  \r