From: klu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Thu, 17 Apr 2008 02:36:59 +0000 (+0000)
Subject: Add function doxygen header for VgaMiniPort module.
X-Git-Tag: edk2-stable201903~21127
X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=fcf03596d10de53e45292bd9eb4767a8ddc344ed

Add function doxygen header for VgaMiniPort module.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5075 6f19259b-4bc3-4df7-8a09-765794883524
---

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