[Description]

  Scrub MdePkg:
  - Add file description with doxygen format.
  - Add calling convention of library class in MdePkg.
  - Add function descriptions of public protocol/library class.

[Impaction]
  It should be backward-compatible.

[Ref Info]
  N/A

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

diff --git a/MdePkg/Include/Guid/HiiKeyBoardLayout.h b/MdePkg/Include/Guid/HiiKeyBoardLayout.h
index 3c29bd725eee1b0d03d50512bdf482e4f2f16773..cb76307c5542e9d107b329ed11550241649ae06e 100644 (file)
--- a/MdePkg/Include/Guid/HiiKeyBoardLayout.h
+++ b/MdePkg/Include/Guid/HiiKeyBoardLayout.h
@@ -1,5 +1,7 @@
 /** @file\r
 \r
+  HII keyboard layout GUID as defined in UEFI2.1 specification\r
+  \r
   Copyright (c) 2006 - 2007, Intel Corporation\r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r

diff --git a/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h b/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h
index 3d249d3d631cde18d41d2b4354e02e43763ac211..d47430b82fae4152a23e8bf27695aac83995399d 100644 (file)
--- a/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h
+++ b/MdePkg/Include/IndustryStandard/IScsiBootFirmwareTable.h
@@ -1,23 +1,17 @@
 /** @file\r
 \r
-Copyright (c) 2005 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-Module Name:\r
-\r
-  IScsiBootFirmwareTable.h\r
-\r
-Abstract:\r
-\r
   The definition for iSCSI Boot Firmware Table, it's defined in\r
   Microsoft iBFT document.\r
 \r
+  Copyright (c) 2006 - 2007, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials                          \r
+  are licensed and made available under the terms and conditions of the BSD License         \r
+  which accompanies this distribution.  The full text of the license may be found at        \r
+  http://opensource.org/licenses/bsd-license.php                                            \r
+\r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.             \r
+\r
 **/\r
 \r
 #ifndef _ISCSI_BOOT_FIRMWARE_TABLE_H_\r

diff --git a/MdePkg/Include/Library/PeiServicesTablePointerLib.h b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
index f6ced472651b62bd63ab5496b99b5a365477a0ae..8c133dd1084c3059c9ca8b75ab8c42dbc6275c10 100644 (file)
--- a/MdePkg/Include/Library/PeiServicesTablePointerLib.h
+++ b/MdePkg/Include/Library/PeiServicesTablePointerLib.h
@@ -50,6 +50,7 @@ SetPeiServicesTablePointer (
   @param    PeiServices   The address of PeiServices pointer.\r
 **/\r
 VOID\r
+EFIAPI\r
 MigrateIdtTable (\r
   IN EFI_PEI_SERVICES  **PeiServices\r
   );\r

diff --git a/MdePkg/Include/Pi/PiHob.h b/MdePkg/Include/Pi/PiHob.h
index b415f1cdaddbb95375dfeeb95d3446dd5c2c7686..95de43f02f6821acb79399eb0b4cfbc937e5083a 100644 (file)
--- a/MdePkg/Include/Pi/PiHob.h
+++ b/MdePkg/Include/Pi/PiHob.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   HOB related definitions in PI.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation                                                         \r

diff --git a/MdePkg/Include/Ppi/Decompress.h b/MdePkg/Include/Ppi/Decompress.h
index e64661b9c2e1d8a2da25758894d9fcccde3f0116..1c013bea2d1d7b60ab2f53883183db44a9286fe0 100644 (file)
--- a/MdePkg/Include/Ppi/Decompress.h
+++ b/MdePkg/Include/Ppi/Decompress.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   Provides decompression services to the PEI Foundatoin.\r
 \r
   Copyright (c) 2006, Intel Corporation                                                         \r

diff --git a/MdePkg/Include/Ppi/FirmwareVolume.h b/MdePkg/Include/Ppi/FirmwareVolume.h
index f88beee6ce4a1cd0de3d95205375b6571345ee42..33b5ebb70e333260eec84c5301f43e889917c4e6 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolume.h
+++ b/MdePkg/Include/Ppi/FirmwareVolume.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   This file provides functions for accessing a memory-mapped firmware volume of a specific format.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation                                                         \r

diff --git a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
index 8d44a31d4a55493fedee5372c8ded773eaaf47d1..e66bfed51b376ee94c8a6d80cff91dbb1e9402ed 100644 (file)
--- a/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
+++ b/MdePkg/Include/Ppi/FirmwareVolumeInfo.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   This file provides location and format of a firmware volume.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation                                                         \r

diff --git a/MdePkg/Include/Ppi/GuidedSectionExtraction.h b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
index 80b1ee1210ede4189b8d373e692f36702f90d01f..d4753f9ac4b82f38bf03ede05f9e9a792be28752 100644 (file)
--- a/MdePkg/Include/Ppi/GuidedSectionExtraction.h
+++ b/MdePkg/Include/Ppi/GuidedSectionExtraction.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   If a GUID-defined section is encountered when doing section extraction, \r
   the PEI Foundation or the EFI_PEI_FILE_LOADER_PPI instance \r
   calls the appropriate instance of the GUIDed Section Extraction PPI \r

diff --git a/MdePkg/Include/Ppi/LoadImage.h b/MdePkg/Include/Ppi/LoadImage.h
index 5b2ce9acd205bee7a216e258465402b4022113f8..7e0679bd1d82c9ee62bf0d358ce68f18dcfbbd55 100644 (file)
--- a/MdePkg/Include/Ppi/LoadImage.h
+++ b/MdePkg/Include/Ppi/LoadImage.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   The file descript the PPI which notifies other drivers \r
   of the PEIM being initialized by the PEI Dispatcher.\r
 \r

diff --git a/MdePkg/Include/Ppi/Pcd.h b/MdePkg/Include/Ppi/Pcd.h
index 92ffbb8b07b0c56db36565881621843ccd0f3f8a..4d62de64ebd749ce71806221786ba919517c45b5 100644 (file)
--- a/MdePkg/Include/Ppi/Pcd.h
+++ b/MdePkg/Include/Ppi/Pcd.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   Platform Configuration Database (PCD) PPI\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation                                                         \r

diff --git a/MdePkg/Include/Ppi/TemporaryRamSupport.h b/MdePkg/Include/Ppi/TemporaryRamSupport.h
index b8d2e7fda57abc26007ab50e2a440e2803330e5c..447c66da569f9c005ea453d70deb5b79f21a2330 100644 (file)
--- a/MdePkg/Include/Ppi/TemporaryRamSupport.h
+++ b/MdePkg/Include/Ppi/TemporaryRamSupport.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   This file declares Temporary RAM Support PPI.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation                                                         \r

diff --git a/MdePkg/Include/Protocol/Arp.h b/MdePkg/Include/Protocol/Arp.h
index c9000c7062ef66da28814211a2a957b0738b8ee9..662fd9de2529af66ca4630eec5bcef1fa296af01 100644 (file)
--- a/MdePkg/Include/Protocol/Arp.h
+++ b/MdePkg/Include/Protocol/Arp.h
@@ -1,4 +1,15 @@
 /** @file\r
+  \r
+  EFI ARP Protocol Definition\r
+  \r
+  The EFI ARP Service Binding Protocol is used to locate EFI\r
+  ARP Protocol drivers to create and destroy child of the\r
+  driver to communicate with other host using ARP protocol.\r
+  \r
+  The EFI ARP Protocol provides services to map IP network\r
+  address to hardware address used by a data link protocol.\r
+  \r
+  \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r

diff --git a/MdePkg/Include/Protocol/DebugPort.h b/MdePkg/Include/Protocol/DebugPort.h
index d560554ce92a0b79207c78643df16b2e3d80dad1..afe656ded515bb5a62b454dd315809c23faf2f9c 100644 (file)
--- a/MdePkg/Include/Protocol/DebugPort.h
+++ b/MdePkg/Include/Protocol/DebugPort.h
@@ -1,4 +1,9 @@
 /** @file\r
+  \r
+  The file defines the EFI Debugport protocol.\r
+  This protocol is used by debug agent to communicate with the\r
+  remote debug host.\r
+  \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r

diff --git a/MdePkg/Include/Protocol/Ip4.h b/MdePkg/Include/Protocol/Ip4.h
index 99885496458d945a4f3053e2ac9cc57ea4685fd4..a72244e2c8cc6b05caab21d6302ce075fa45e671 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4.h
+++ b/MdePkg/Include/Protocol/Ip4.h
@@ -1,4 +1,16 @@
 /** @file\r
+  \r
+  This file defines the EFI IPv4 (Internet Protocol version 4)\r
+  Protocol interface. It is split into the following three main\r
+  sections:\r
+  - EFI IPv4 Service Binding Protocol\r
+  - EFI IPv4 Variable\r
+  - EFI IPv4 Protocol The EFI IPv4 Protocol provides basic\r
+    network IPv4 packet I/O services, which includes support for\r
+    a subset of the Internet Control Message Protocol (ICMP) and\r
+    may include support for the Internet Group Management\r
+    Protocol (IGMP).\r
+  \r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r

diff --git a/MdePkg/Include/Protocol/Ip4Config.h b/MdePkg/Include/Protocol/Ip4Config.h
index e744ce42c9f3989672cb1fef10adf31cda382ff2..23a6f7d2d3becb6cfe778d4760a734147af918d1 100644 (file)
--- a/MdePkg/Include/Protocol/Ip4Config.h
+++ b/MdePkg/Include/Protocol/Ip4Config.h
@@ -1,4 +1,8 @@
 /** @file\r
+\r
+  This file provides a definition of the EFI IPv4 Configuration\r
+  Protocol.\r
+\r
   Copyright (c) 2006, Intel Corporation\r
   All rights reserved. This program and the accompanying materials\r
   are licensed and made available under the terms and conditions of the BSD License\r
@@ -9,7 +13,6 @@
   WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
-\r
 #ifndef __EFI_IP4CONFIG_PROTOCOL_H__\r
 #define __EFI_IP4CONFIG_PROTOCOL_H__\r
 \r

diff --git a/MdePkg/Include/Protocol/ServiceBinding.h b/MdePkg/Include/Protocol/ServiceBinding.h
index 2fd0805f46e4e246c09b68b07c76aae8d0b720c1..42cd9978c4bde81f1ec7b441e60426d0ce3af80a 100644 (file)
--- a/MdePkg/Include/Protocol/ServiceBinding.h
+++ b/MdePkg/Include/Protocol/ServiceBinding.h
@@ -1,4 +1,9 @@
 /** @file\r
+\r
+  The file defines the generic Service Binding Protocol\r
+  functions.\r
+\r
+\r
   Copyright (c) 2006, Intel Corporation                                                         \r
   All rights reserved. This program and the accompanying materials                          \r
   are licensed and made available under the terms and conditions of the BSD License         \r

diff --git a/MdePkg/Include/Uefi/UefiBaseType.h b/MdePkg/Include/Uefi/UefiBaseType.h
index f4119c1c7e577235730087fef388f4e60c5558a3..b75c72d3e20781622189a6630a7f69f60173286d 100644 (file)
--- a/MdePkg/Include/Uefi/UefiBaseType.h
+++ b/MdePkg/Include/Uefi/UefiBaseType.h
@@ -1,16 +1,15 @@
-\r
-/* @file\r
+/** @file\r
 \r
   Defines data types and constants introduced in UEFI.\r
 \r
-Copyright (c) 2006 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  Copyright (c) 2006 - 2007, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+  \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r

diff --git a/MdePkg/Include/Uefi/UefiGpt.h b/MdePkg/Include/Uefi/UefiGpt.h
index 202397b80ff4cfaa1e66e739d38ddfb77f59e3e2..c79d80823a9c43f73c2d53605bcd1bdc8c799acf 100644 (file)
--- a/MdePkg/Include/Uefi/UefiGpt.h
+++ b/MdePkg/Include/Uefi/UefiGpt.h
@@ -1,4 +1,4 @@
-/* @file\r
+/** @file\r
   EFI Guid Partition Table Format Definition.\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation\r

diff --git a/MdePkg/Include/Uefi/UefiTcgPlatform.h b/MdePkg/Include/Uefi/UefiTcgPlatform.h
index 12f53b6a253c3395aae41828a72aae7e7ce2cb6f..f577d75e33b243cc40c519f05fae4de1c161375a 100644 (file)
--- a/MdePkg/Include/Uefi/UefiTcgPlatform.h
+++ b/MdePkg/Include/Uefi/UefiTcgPlatform.h
@@ -1,4 +1,5 @@
-/* @file\r
+/** @file\r
+  \r
   TCG EFI Platform Definition in TCG_EFI_Platform_1_20_Final\r
 \r
   Copyright (c) 2006 - 2007, Intel Corporation\r

diff --git a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
index 2536d6a8614f3609d99b69227986af743f79a3aa..42f4e1b637503b54eb5614e822f5eb1d6a480b68 100644 (file)
--- a/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
+++ b/MdePkg/Library/PeiServicesTablePointerLibIdt/PeiServicesTablePointer.c
@@ -73,6 +73,7 @@ SetPeiServicesTablePointer (
   @param    PeiServices   The address of PeiServices pointer.\r
 **/\r
 VOID\r
+EFIAPI\r
 MigrateIdtTable (\r
   IN EFI_PEI_SERVICES  **PeiServices\r
   )\r

diff --git a/MdePkg/Library/UefiUsbLib/Hid.c b/MdePkg/Library/UefiUsbLib/Hid.c
index 9391574fe0a8791b82df6b51122eca6cd4cd5acf..bf40656ae9d54f6935b917dfba336160cfc8f075 100644 (file)
--- a/MdePkg/Library/UefiUsbLib/Hid.c
+++ b/MdePkg/Library/UefiUsbLib/Hid.c
@@ -1,14 +1,15 @@
 /** @file\r
 \r
-Copyright (c) 2004, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
+  The library provides USB descriptor, protocol operations.\r
+  \r
+  Copyright (c) 2004, Intel Corporation\r
+  All rights reserved. This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  The full text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+  \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
 \r
 **/\r
 \r

diff --git a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
index a1d61d52bfe835813af4167b55f46c58b7bb1b37..a3ac0e614016ecff0da5c5ba3c8201c3fe77b8a7 100644 (file)
--- a/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
+++ b/MdePkg/Library/UefiUsbLib/UsbDxeLib.c
@@ -1,15 +1,18 @@
 /** @file\r
 \r
-Copyright (c) 2004 - 2007, Intel Corporation\r
-All rights reserved. This program and the accompanying materials\r
-are licensed and made available under the terms and conditions of the BSD License\r
-which accompanies this distribution.  The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php\r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
-\r
-   Common Dxe Libarary  for USB\r
+  The library provides the USB descritor, interface and protocol\r
+  operations.\r
+  \r
+  Copyright (c) 2004 - 2007, Intel Corporation All rights\r
+  reserved. This program and the accompanying materials are\r
+  licensed and made available under the terms and conditions of\r
+  the BSD License which accompanies this distribution.  The full\r
+  text of the license may be found at\r
+  http://opensource.org/licenses/bsd-license.php\r
+  \r
+  THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,\r
+  WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+  \r
 \r
 **/\r
 \r