Add some function/header comments.

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

7 files changed, 22 insertions, 33 deletions

diff --git a/IntelFrameworkModulePkg/Include/Guid/CustomDecompress.h b/IntelFrameworkModulePkg/Include/Guid/CustomDecompress.h
index c03524e02b..3e98785c2b 100644
--- a/IntelFrameworkModulePkg/Include/Guid/CustomDecompress.h
+++ b/IntelFrameworkModulePkg/Include/Guid/CustomDecompress.h
@@ -1,5 +1,6 @@
 /** @file

-

+  Custom decompress Guid definitions

+  

 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

@@ -9,20 +10,12 @@ http://opensource.org/licenses/bsd-license.php
 THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

 WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-Module Name:

-

-  CustomDecompress.h

-

-Abstract:

-

-  Custom decompress Guid definitions

-

 **/

 

 #ifndef __EFI_CUSTOM_DECOMPRESS_GUID_H__

 #define __EFI_CUSTOM_DECOMPRESS_GUID_H__

 

-#define TINAO_CUSTOM_DECOMPRESS_GUID  \

+#define TIANO_CUSTOM_DECOMPRESS_GUID  \

   { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 } }

 

 extern GUID gTianoCustomDecompressGuid;

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubProducer.h b/IntelFrameworkModulePkg/Include/Guid/DataHubProducer.h
index ec7c1fdb89..0385be1de1 100644
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubProducer.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubProducer.h
@@ -36,5 +36,4 @@ extern  EFI_GUID gEfiMemoryProducerGuid;
 

 extern  EFI_GUID gEfiMiscProducerGuid;

 

-

-#endif

+#endif // _DATAHUB_PRODUCER_H_

diff --git a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
index 54382f4ef3..34c1fefe37 100644
--- a/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
+++ b/IntelFrameworkModulePkg/Include/Guid/DataHubStatusCodeRecord.h
@@ -32,4 +32,5 @@ typedef struct {
 

 extern EFI_GUID gEfiDataHubStatusCodeRecordGuid;

 

-#endif

+#endif // __STATUS_CODE_H__

+

diff --git a/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h b/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
index 197a0465b7..e2c6e7ae84 100644
--- a/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
+++ b/IntelFrameworkModulePkg/Include/Guid/PciHotplugDevice.h
@@ -20,4 +20,5 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 extern EFI_GUID gEfiPciHotplugDeviceGuid;

 

-#endif

+#endif // __PCI_HOTPLUG_DEVICE_GUID_H_

+

diff --git a/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h b/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
index ef9e345de5..32ab10ac3d 100644
--- a/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
+++ b/IntelFrameworkModulePkg/Include/Guid/PciOptionRomTable.h
@@ -37,4 +37,5 @@ typedef struct {
   EFI_PCI_OPTION_ROM_DESCRIPTOR   *PciOptionRomDescriptors;

 } EFI_PCI_OPTION_ROM_TABLE;

 

-#endif

+#endif // __PCI_OPTION_ROM_TABLE_GUID_H_

+

diff --git a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
index b26189c941..5f5726ea8a 100644
--- a/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
+++ b/IntelFrameworkModulePkg/Include/Library/OemHookStatusCodeLib.h
@@ -1,4 +1,3 @@
-

 /** @file

   OEM hook status code library functions with no library constructor/destructor

 

@@ -11,8 +10,6 @@
   THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,

   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.

 

-  Module Name:  OemHookStatusCodeLib.h

-

 **/

 

 #ifndef __OEM_HOOK_STATUSCODE_LIB__

@@ -70,4 +67,5 @@ OemHookStatusCodeReport (
   IN EFI_STATUS_CODE_DATA     *Data      OPTIONAL

   );

 

-#endif

+#endif // __OEM_HOOK_STATUSCODE_LIB__

+

diff --git a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
index bb9802420c..714028993c 100644
--- a/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
+++ b/IntelFrameworkModulePkg/Include/Protocol/VgaMiniPort.h
@@ -22,6 +22,16 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

 typedef struct _EFI_VGA_MINI_PORT_PROTOCOL  EFI_VGA_MINI_PORT_PROTOCOL;

 

+/**

+  Sets the text display mode of a VGA controller

+  

+  @param This             Protocol instance pointer.

+  @param Mode             Mode number.  0 - 80x25   1-80x50

+

+  @retval EFI_SUCCESS            The mode was set

+  @retval EFI_DEVICE_ERROR       The device is not functioning properly.

+  

+**/

 typedef

 EFI_STATUS

 (EFIAPI *EFI_VGA_MINI_PORT_SET_MODE) (

@@ -29,20 +39,6 @@ EFI_STATUS
   IN UINTN                               ModeNumber

   );

 

-/*++

-

-  Routine Description:

-    Sets the text display mode of a VGA controller

-

-  Arguments:

-    This                 - Protocol instance pointer.

-    Mode                 - Mode number.  0 - 80x25   1-80x50

-

-  Returns:

-    EFI_SUCCESS           - The mode was set

-    EFI_DEVICE_ERROR      - The device is not functioning properly.

-

---*/

 struct _EFI_VGA_MINI_PORT_PROTOCOL {

   EFI_VGA_MINI_PORT_SET_MODE  SetMode;