Correct the structure's comments to follow doxygen format.

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

4 files changed, 17 insertions, 17 deletions

diff --git a/IntelFrameworkPkg/Include/Guid/Capsule.h b/IntelFrameworkPkg/Include/Guid/Capsule.h
index d0f3df772d..dc9d2be42b 100644
--- a/IntelFrameworkPkg/Include/Guid/Capsule.h
+++ b/IntelFrameworkPkg/Include/Guid/Capsule.h
@@ -1,7 +1,7 @@
 /** @file

   GUIDs used for EFI Capsule

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 2009, 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

   which accompanies this distribution.  The full text of the license may be found at

@@ -52,10 +52,10 @@
 // a capsule update.

 //

 typedef struct {

-  UINT64                Length;     // length of the data block

-  EFI_PHYSICAL_ADDRESS  Data;       // physical address of the data block

-  UINT32                Signature;  // CBDS

-  UINT32                CheckSum;   // to sum this structure to 0

+  UINT64                Length;     ///< length of the data block

+  EFI_PHYSICAL_ADDRESS  Data;       ///< physical address of the data block

+  UINT32                Signature;  ///< CBDS

+  UINT32                CheckSum;   ///< to sum this structure to 0

 } FRAMEWORK_EFI_CAPSULE_BLOCK_DESCRIPTOR;

 

 typedef struct {

diff --git a/IntelFrameworkPkg/Include/Guid/DataHubRecords.h b/IntelFrameworkPkg/Include/Guid/DataHubRecords.h
index 323acdb3c4..b8ff601e93 100644
--- a/IntelFrameworkPkg/Include/Guid/DataHubRecords.h
+++ b/IntelFrameworkPkg/Include/Guid/DataHubRecords.h
@@ -1,7 +1,7 @@
 /** @file

   DataHubRecord.h include all data hub sub class GUID defitions.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 2009, 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

   which accompanies this distribution.  The full text of the license may be found at

@@ -33,10 +33,10 @@ extern  EFI_GUID gEfiProcessorSubClassGuid;
 

 extern  EFI_GUID gEfiCacheSubClassGuid;

 

-//

-// The memory subclass belongs to the data class and is identified as the memory 

-// subclass by the GUID.

-//

+///

+/// The memory subclass belongs to the data class and is identified as the memory 

+/// subclass by the GUID.

+///

 #define EFI_MEMORY_SUBCLASS_GUID \

   {0x4E8F4EBB, 0x64B9, 0x4e05, {0x9B, 0x18, 0x4C, 0xFE, 0x49, 0x23, 0x50, 0x97} }

 

diff --git a/IntelFrameworkPkg/Include/Guid/FirmwareFileSystem.h b/IntelFrameworkPkg/Include/Guid/FirmwareFileSystem.h
index af091a538b..a27a8a2a85 100644
--- a/IntelFrameworkPkg/Include/Guid/FirmwareFileSystem.h
+++ b/IntelFrameworkPkg/Include/Guid/FirmwareFileSystem.h
@@ -2,7 +2,7 @@
   Guid used to define the Firmware File System.  See the Framework Firmware

   File System Specification for more details.

 

-  Copyright (c) 2006, Intel Corporation

+  Copyright (c) 2006 - 2009, 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

   which accompanies this distribution.  The full text of the license may be found at

@@ -23,9 +23,9 @@
 

 #include <PiPei.h>

 

-//

-// GUIDs defined by the FFS specification.

-//

+///

+/// GUIDs defined by the FFS specification.

+///

 #define EFI_FIRMWARE_FILE_SYSTEM_GUID \

   { 0x7A9354D9, 0x0468, 0x444a, {0x81, 0xCE, 0x0B, 0xF6, 0x17, 0xD8, 0x90, 0xDF }}

 

diff --git a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
index d13119d45f..fcdcf1d83c 100644
--- a/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
+++ b/IntelFrameworkPkg/Include/Guid/SmramMemoryReserve.h
@@ -1,7 +1,7 @@
 /** @file

   GUID for use in reserving SMRAM regions.

 

-  Copyright (c) 2007, Intel Corporation

+  Copyright (c) 2007 - 2009, 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

   which accompanies this distribution.  The full text of the license may be found at

@@ -33,8 +33,8 @@
 // *******************************************************

 //

 typedef struct {

-  EFI_PHYSICAL_ADDRESS  PhysicalStart;  // Phsyical location in DRAM

-  EFI_PHYSICAL_ADDRESS  CpuStart;       // Address CPU uses to access the SMI handler

+  EFI_PHYSICAL_ADDRESS  PhysicalStart;  ///< Phsyical location in DRAM

+  EFI_PHYSICAL_ADDRESS  CpuStart;       ///< Address CPU uses to access the SMI handler

   // May or may not match PhysicalStart

   //

   UINT64                PhysicalSize;