Correct the structure's comments to follow doxygen format.

[mirror_edk2.git] / IntelFrameworkPkg / Include / Guid / Capsule.h

diff --git a/IntelFrameworkPkg/Include/Guid/Capsule.h b/IntelFrameworkPkg/Include/Guid/Capsule.h
index 858b290cc913bfb3a37ff7957a136a900ef9fee4..dc9d2be42ba2df9a967605cf3329ed52139ddb4f 100644 (file)
--- a/IntelFrameworkPkg/Include/Guid/Capsule.h
+++ b/IntelFrameworkPkg/Include/Guid/Capsule.h
@@ -1,7 +1,7 @@
 /** @file\r
   GUIDs used for EFI Capsule\r
 \r
-  Copyright (c) 2007, Intel Corporation\r
+  Copyright (c) 2007 - 2009, 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
@@ -45,17 +45,17 @@
 #define EFI_CAPSULE_HEADER_FLAG_SETUP 0x00000001  // supports setup changes\r
 \r
 \r
-#define CAPSULE_BLOCK_DESCRIPTOR_SIGNATURE  EFI_SIGNATURE_32 ('C', 'B', 'D', 'S')\r
+#define CAPSULE_BLOCK_DESCRIPTOR_SIGNATURE  SIGNATURE_32 ('C', 'B', 'D', 'S')\r
 \r
 //\r
 // An array of these describe the blocks that make up a capsule for\r
 // a capsule update.\r
 //\r
 typedef struct {\r
-  UINT64                Length;     // length of the data block\r
-  EFI_PHYSICAL_ADDRESS  Data;       // physical address of the data block\r
-  UINT32                Signature;  // CBDS\r
-  UINT32                CheckSum;   // to sum this structure to 0\r
+  UINT64                Length;     ///< length of the data block\r
+  EFI_PHYSICAL_ADDRESS  Data;       ///< physical address of the data block\r
+  UINT32                Signature;  ///< CBDS\r
+  UINT32                CheckSum;   ///< to sum this structure to 0\r
 } FRAMEWORK_EFI_CAPSULE_BLOCK_DESCRIPTOR;\r
 \r
 typedef struct {\r