From a90ccab851017e45d32ade0644aca0957a9ea430 Mon Sep 17 00:00:00 2001 From: lgao4 Date: Fri, 7 Aug 2009 02:20:01 +0000 Subject: [PATCH] Correct the format of comments git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@9029 6f19259b-4bc3-4df7-8a09-765794883524 --- .../IntelFrameworkModulePkg.dec | 22 +++--- MdeModulePkg/MdeModulePkg.dec | 73 ++++++++----------- MdePkg/MdePkg.dec | 6 +- 3 files changed, 44 insertions(+), 57 deletions(-) diff --git a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec index a83d56c320..e7f496bbed 100644 --- a/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec +++ b/IntelFrameworkModulePkg/IntelFrameworkModulePkg.dec @@ -35,48 +35,48 @@ [Guids] ## IntelFrameworkModule package token space guid - ## Include/Guid/IntelFrameworkModulePkgTokenSpace.h + # Include/Guid/IntelFrameworkModulePkgTokenSpace.h gEfiIntelFrameworkModulePkgTokenSpaceGuid = { 0xD3705011, 0xBC19, 0x4af7, { 0xBE, 0x16, 0xF6, 0x80, 0x30, 0x37, 0x8C, 0x15 }} ## GUID identifies status code records HOB that originate from the PEI status code - ## Include/Guid/MemoryStatusCodeRecord.h + # Include/Guid/MemoryStatusCodeRecord.h gMemoryStatusCodeRecordGuid = { 0x060CC026, 0x4C0D, 0x4DDA, { 0x8F, 0x41, 0x59, 0x5F, 0xEF, 0x00, 0xA5, 0x02 }} ## GUID identifies Data Hub records logged by Status Code Runtime Protocol. - ## Include/Guid/DataHubStatusCodeRecord.h + # Include/Guid/DataHubStatusCodeRecord.h gEfiDataHubStatusCodeRecordGuid = { 0xD083E94C, 0x6560, 0x42E4, { 0xB6, 0xD4, 0x2D, 0xF7, 0x5A, 0xDF, 0x6A, 0x2A }} ## GUID indicates the tiano custom compress/decompress algorithm. - ## Include/Guid/TianoDecompress.h + # Include/Guid/TianoDecompress.h gTianoCustomDecompressGuid = { 0xA31280AD, 0x481E, 0x41B6, { 0x95, 0xE8, 0x12, 0x7F, 0x4C, 0x98, 0x47, 0x79 }} ## GUID indicates the LZMA custom compress/decompress algorithm. - ## Include/Guid/LzmaDecompress.h + # Include/Guid/LzmaDecompress.h gLzmaCustomDecompressGuid = { 0xEE4E5898, 0x3914, 0x4259, { 0x9D, 0x6E, 0xDC, 0x7B, 0xD7, 0x94, 0x03, 0xCF }} ## GUID used to pass DEBUG() macro information through the Status Code Protocol and Status Code PPI - ## Include/Guid/StatusCodeDataTypeDebug.h + # Include/Guid/StatusCodeDataTypeDebug.h gEfiStatusCodeDataTypeDebugGuid = { 0x9A4E9246, 0xD553, 0x11D5, { 0x87, 0xE2, 0x00, 0x06, 0x29, 0x45, 0xC3, 0xB9 }} [Protocols] ## Vga Mini port binding for a VGA controller - ## Include/Protocol/VgaMiniPort.h + # Include/Protocol/VgaMiniPort.h gEfiVgaMiniPortProtocolGuid = { 0xc7735a2f, 0x88f5, 0x4882, { 0xae, 0x63, 0xfa, 0xac, 0x8c, 0x8b, 0x86, 0xb3 }} ## ISA I/O Protocol is used to perform ISA device Io/Mem operations. - ## Include/Protocol/IsaIo.h + # Include/Protocol/IsaIo.h gEfiIsaIoProtocolGuid = { 0x7ee2bd44, 0x3da0, 0x11d4, { 0x9a, 0x38, 0x0, 0x90, 0x27, 0x3f, 0xc1, 0x4d }} ## ISA Acpi Protocol is used to operate and communicate with ISA device. - ## Include/Protocol/IsaAcpi.h + # Include/Protocol/IsaAcpi.h gEfiIsaAcpiProtocolGuid = { 0x64a892dc, 0x5561, 0x4536, { 0x92, 0xc7, 0x79, 0x9b, 0xfc, 0x18, 0x33, 0x55 }} ## PS/2 policy protocol abstracts the specific platform initialization and setting. - ## Include/Protocol/Ps2Policy.h + # Include/Protocol/Ps2Policy.h gEfiPs2PolicyProtocolGuid = { 0x4DF19259, 0xDC71, 0x4D46, { 0xBE, 0xF1, 0x35, 0x7B, 0xB5, 0x78, 0xC4, 0x18 }} ## OEM Badging Protocol defines the interface to get the OEM badging image with the dispaly attribute. - ## Include/Protocol/OEMBadging.h + # Include/Protocol/OEMBadging.h gEfiOEMBadgingProtocolGuid = { 0x170E13C0, 0xBF1B, 0x4218, { 0x87, 0x1D, 0x2A, 0xBD, 0xC6, 0xF8, 0x87, 0xBC }} [PcdsFeatureFlag] diff --git a/MdeModulePkg/MdeModulePkg.dec b/MdeModulePkg/MdeModulePkg.dec index 0f0ebfcbd8..0da12affa7 100644 --- a/MdeModulePkg/MdeModulePkg.dec +++ b/MdeModulePkg/MdeModulePkg.dec @@ -60,17 +60,17 @@ DpcLib|Include/Library/DpcLib.h ## @libraryclass Provides global variables that are pointers - ## to the UEFI HII related protocols. - ## + # to the UEFI HII related protocols. + # UefiHiiServicesLib|Include/Library/UefiHiiServicesLib.h [Guids.common] ## MdeModule package token space guid - ## Include/Guid/MdeModulePkgTokenSpace.h + # Include/Guid/MdeModulePkgTokenSpace.h gEfiMdeModulePkgTokenSpaceGuid = { 0xA1AFF049, 0xFDEB, 0x442a, { 0xB3, 0x20, 0x13, 0xAB, 0x4C, 0xB7, 0x2B, 0xBC }} ## Hob guid for Pcd DataBase - ## Include/Guid/PcdDataBaseHobGuid.h + # Include/Guid/PcdDataBaseHobGuid.h gPcdDataBaseHobGuid = { 0xEA296D92, 0x0B69, 0x423C, { 0x8C, 0x28, 0x33, 0xB4, 0xE0, 0xA9, 0x12, 0x68 }} ## Guid for EDKII implementation GUIDed opcodes @@ -82,39 +82,39 @@ gEfiIfrFrameworkGuid = { 0x31ca5d1a, 0xd511, 0x4931, { 0xb7, 0x82, 0xae, 0x6b, 0x2b, 0x17, 0x8c, 0xd7 }} ## Guid to specify the System Non Volatile FV - ## Include/Guid/SystemNvDataGuid.h + # Include/Guid/SystemNvDataGuid.h gEfiSystemNvDataFvGuid = { 0xFFF12B8D, 0x7696, 0x4C8B, { 0xA9, 0x85, 0x27, 0x47, 0x07, 0x5B, 0x4F, 0x50 }} ## Guid specify the device is the console out device. - ## Include/Guid/ConsoleOutDevice.h + # Include/Guid/ConsoleOutDevice.h gEfiConsoleOutDeviceGuid = { 0xD3B36F2C, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }} ## Guid specify the device is the console in device. - ## Include/Guid/ConsoleInDevice.h + # Include/Guid/ConsoleInDevice.h gEfiConsoleInDeviceGuid = { 0xD3B36F2B, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }} ## Hob and Variable guid specify the platform memory type information. - ## Include/Guid/MemoryTypeInformation.h + # Include/Guid/MemoryTypeInformation.h gEfiMemoryTypeInformationGuid = { 0x4C19049F, 0x4137, 0x4DD3, { 0x9C, 0x10, 0x8B, 0x97, 0xA8, 0x3F, 0xFD, 0xFA }} ## Capsule update hob and variable guid - ## Include/Guid/CapsuleVendor.h + # Include/Guid/CapsuleVendor.h gEfiCapsuleVendorGuid = { 0x711C703F, 0xC285, 0x4B10, { 0xA3, 0xB0, 0x36, 0xEC, 0xBD, 0x3C, 0x8B, 0xE2 }} ## Guid specifiy the device is the StdErr device. - ## Include/Guid/StandardErrorDevice.h + # Include/Guid/StandardErrorDevice.h gEfiStandardErrorDeviceGuid = { 0xD3B36F2D, 0xD551, 0x11D4, { 0x9A, 0x46, 0x00, 0x90, 0x27, 0x3F, 0xC1, 0x4D }} ## Guid acted as variable store header's signature and to specify the variable list entries put in the EFI system table. - ## Include/Guid/VariableFormat.h + # Include/Guid/VariableFormat.h gEfiVariableGuid = { 0xddcf3616, 0x3275, 0x4164, { 0x98, 0xb6, 0xfe, 0x85, 0x70, 0x7f, 0xfe, 0x7d }} ## Performance protocol guid that also acts as the performance HOB guid and performance variable GUID - ## Include/Guid/Performance.h + # Include/Guid/Performance.h gPerformanceProtocolGuid = { 0x76B6BDFA, 0x2ACD, 0x4462, { 0x9E, 0x3F, 0xCB, 0x58, 0xC9, 0x69, 0xD9, 0x37 }} ## Guid is defined for CRC32 encapsulation scheme. - ## Include/Guid/Crc32GuidedSectionExtraction.h + # Include/Guid/Crc32GuidedSectionExtraction.h gEfiCrc32GuidedSectionExtractionGuid = { 0xFC1BCDB0, 0x7D31, 0x49aa, {0x93, 0x6A, 0xA4, 0x60, 0x0D, 0x9D, 0xD0, 0x83 } } ## Include/Guid/NicIp4ConfigNvData.h @@ -122,17 +122,17 @@ [Protocols.common] ## Load File protocol provides capability to load and unload EFI image into memory and execute it. - ## Include/Protocol/LoadPe32Image.h - ## This protocol is deprecated. Native EDKII module should NOT use this protocol to load/unload image. - ## If developer need implement such functionality, they should use BasePeCoffLib. + # Include/Protocol/LoadPe32Image.h + # This protocol is deprecated. Native EDKII module should NOT use this protocol to load/unload image. + # If developer need implement such functionality, they should use BasePeCoffLib. gEfiLoadPeImageProtocolGuid = { 0x5CB5C776, 0x60D5, 0x45EE, { 0x88, 0x3C, 0x45, 0x27, 0x08, 0xCD, 0x74, 0x3F }} ## Print protocol defines basic print functions to print the format unicode and ascii string. - ## Include/Protocol/Print2.h + # Include/Protocol/Print2.h gEfiPrint2ProtocolGuid = { 0xf05976ef, 0x83f1, 0x4f3d, { 0x86, 0x19, 0xf7, 0x59, 0x5d, 0x41, 0xe5, 0x38 } } ## This protocol defines the generic memory test interfaces in Dxe phase. - ## Include/Protocol/GenericMemoryTest.h + # Include/Protocol/GenericMemoryTest.h gEfiGenericMemTestProtocolGuid = { 0x309DE7F1, 0x7F5E, 0x4ACE, { 0xB4, 0x9C, 0x53, 0x1B, 0xE5, 0xAA, 0x95, 0xEF }} ## Include/Protocol/Dpc.h @@ -152,7 +152,7 @@ ## This feature flag can be used to enable or disable all PCD PEIM services. # If TRUE, all PCD PPI services will be produced. - ## If FALSE, the minimal PCD PEIM services (only GetService) will be produced. + # If FALSE, the minimal PCD PEIM services (only GetService) will be produced. gEfiMdeModulePkgTokenSpaceGuid.PcdPeiFullPcdDatabaseEnable|TRUE|BOOLEAN|0x00010020 ## If TRUE, then the Device Path To Text Protocol should be produced by the platform. @@ -193,7 +193,6 @@ ## If TRUE, force to switch off the support of legacy usb. So legacy usb device driver can not make use of SMI # interrupt to access usb device in the case of absence of usb stack. - ## gEfiMdeModulePkgTokenSpaceGuid.PcdTurnOffUsbLegacySupport|FALSE|BOOLEAN|0x00010047 ## If TRUE, HiiImageProtocol will be installed. @@ -207,22 +206,18 @@ ## If TRUE, Setup Browser supports GUID opcodes generated from Framework HII VFR file by VFR compiler. # If TRUE, the PeiCore will handle the framework FvHob and install FvInfo PPI for it. - ## This is used to provide backward compatibility support to Framework HII and Framework FvHob. + # This is used to provide backward compatibility support to Framework HII and Framework FvHob. gEfiMdeModulePkgTokenSpaceGuid.PcdFrameworkCompatibilitySupport|FALSE|BOOLEAN|0x00012009 - ## - # If TRUE, HelloWorld Application will print the verbose information. + ## If TRUE, HelloWorld Application will print the verbose information. # This PCD is a sample to explain FeatureFlag PCD usage. - ## gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintEnable|TRUE|BOOLEAN|0x0001200a - ## - # If TRUE, FULL FTW protocol services (total six APIs) will be produced. + ## If TRUE, FULL FTW protocol services (total six APIs) will be produced. # If FASLE, only FTW Write service is available. gEfiMdeModulePkgTokenSpaceGuid.PcdFullFtwServiceEnable|TRUE|BOOLEAN|0x0001200b - ## - # If TRUE, DXE IPL must support the UEFI decompression algorithm. + ## If TRUE, DXE IPL must support the UEFI decompression algorithm. # If FALSE, DXE IPL will not support UEFI decompression to save space. gEfiMdeModulePkgTokenSpaceGuid.PcdDxeIplSupportUefiDecompress|TRUE|BOOLEAN|0x0001200c @@ -260,9 +255,9 @@ gEfiMdeModulePkgTokenSpaceGuid.PcdPeiCoreMaxPpiSupported|64|UINT32|0x00010033 ## Size of the NV variable range. Note that this value should less than or equal to PcdFlashNvStorageFtwSpareSize - # The root cause is that variable driver will use FTW protocol to reclaim variable region. - # If the length of variable region is larger than FTW spare size, it means the whole variable region can not - # be reflushed through the manner of fault tolerant write. + # The root cause is that variable driver will use FTW protocol to reclaim variable region. + # If the length of variable region is larger than FTW spare size, it means the whole variable region can not + # be reflushed through the manner of fault tolerant write. gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageVariableSize|0x0|UINT32|0x30000002 ## The maximum size of single common variable, that is non-HwErr type varible. @@ -301,14 +296,10 @@ gEfiMdeModulePkgTokenSpaceGuid.PcdRealTimeClockUpdateTimeout|100000|UINT32|0x00010034 [PcdsPatchableInModule,PcdsDynamic] - ## - # This PCD defines the Console output column and the default value is 25 according to UEFI spec - ## + ## This PCD defines the Console output column and the default value is 25 according to UEFI spec gEfiMdeModulePkgTokenSpaceGuid.PcdConOutRow|25|UINT32|0x40000006 - ## - # This PCD defines the Console output row and the default value is 80 according to UEFI spec - ## + ## This PCD defines the Console output row and the default value is 80 according to UEFI spec gEfiMdeModulePkgTokenSpaceGuid.PcdConOutColumn|80|UINT32|0x40000007 [PcdsFixedAtBuild,PcdsDynamic] @@ -321,17 +312,13 @@ ## Base address of the FTW working block range in flash device. gEfiMdeModulePkgTokenSpaceGuid.PcdFlashNvStorageFtwWorkingBase|0x0|UINT32|0x30000010 - ## - # This PCD defines the print string. + ## This PCD defines the print string. # This PCD is a sample to explain String typed PCD usage. - ## gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintString|L"UEFI Hello World!\n"|VOID*|0x40000004 [PcdsFixedAtBuild,PcdsPatchableInModule,PcdsDynamic] - ## - # This PCD defines the times to print hello world string. + ## This PCD defines the times to print hello world string. # This PCD is a sample to explain FixedAtBuild UINT32 PCD usage. - ## gEfiMdeModulePkgTokenSpaceGuid.PcdHelloWorldPrintTimes|1|UINT32|0x40000005 ## Indicate the max size of the populated capsule image that the platform can support. diff --git a/MdePkg/MdePkg.dec b/MdePkg/MdePkg.dec index 6dc730fe42..16b9ec32b2 100644 --- a/MdePkg/MdePkg.dec +++ b/MdePkg/MdePkg.dec @@ -534,14 +534,14 @@ gEfiPciHotPlugInitProtocolGuid = { 0xaa0e8bc1, 0xdabc, 0x46b0, { 0xa8, 0x44, 0x37, 0xb8, 0x16, 0x9b, 0x2b, 0xea }} ## This protocol is used to add or remove all PCI child devices on the PCI root bridge. - ## Include/Protocol/PciHotPlugRequest.h + # Include/Protocol/PciHotPlugRequest.h gEfiPciHotPlugRequestProtocolGuid = { 0x19CB87AB, 0x2CB9, 0x4665, { 0x83, 0x60, 0xDD, 0xCF, 0x60, 0x54, 0xF7, 0x9D }} ## Include/Protocol/IdeControllerInit.h gEfiIdeControllerInitProtocolGuid = { 0xa1e37052, 0x80d9, 0x4e65, { 0xa3, 0x17, 0x3e, 0x9a, 0x55, 0xc4, 0x3e, 0xc9 }} ## Disk Info protocol is used to export Inquiry Data for a drive. - ## Include/Protocol/DiskInfo.h + # Include/Protocol/DiskInfo.h gEfiDiskInfoProtocolGuid = { 0xD432A67F, 0x14DC, 0x484B, { 0xB3, 0xBB, 0x3F, 0x02, 0x91, 0x84, 0x93, 0x27 }} # @@ -994,5 +994,5 @@ gEfiMdePkgTokenSpaceGuid.PcdUartDefaultStopBits|1|UINT8|0x00000023 ## Indicates the usable type of terminal - # 0-PCANSI, 1-VT100, 2-VT00+, 3-UTF8 + # 0-PCANSI, 1-VT100, 2-VT00+, 3-UTF8 gEfiMdePkgTokenSpaceGuid.PcdDefaultTerminalType|0|UINT8|0x00000024 -- 2.39.2