change comment style from 3 line to 1 line

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

diff --git a/IntelFrameworkPkg/Include/Guid/StatusCodeDataTypeId.h b/IntelFrameworkPkg/Include/Guid/StatusCodeDataTypeId.h
index ce82e4ff3f106d159138c96429da50eb3798886c..b10d1c5ec84a53f182832931a5c114b3465a8c02 100644 (file)
--- a/IntelFrameworkPkg/Include/Guid/StatusCodeDataTypeId.h
+++ b/IntelFrameworkPkg/Include/Guid/StatusCodeDataTypeId.h
@@ -35,65 +35,31 @@
 #pragma pack(1)\r
 \r
 typedef enum {\r
-  ///\r
-  /// A NULL-terminated ASCII string.\r
-  ///\r
-  EfiStringAscii,\r
-  ///\r
-  /// A double NULL-terminated Unicode string.\r
-  ///\r
-  EfiStringUnicode,\r
-  ///\r
-  /// An EFI_STATUS_CODE_STRING_TOKEN representing the string. The actual string\r
-  /// can be obtained by querying the HII Database.\r
-  ///\r
-  EfiStringToken\r
+  EfiStringAscii,    ///< A NULL-terminated ASCII string.\r
+  EfiStringUnicode,  ///< A double NULL-terminated Unicode string.\r
+  EfiStringToken     ///< An EFI_STATUS_CODE_STRING_TOKEN representing the string. \r
+                     ///< The actual string can be obtained by querying the HII Database.\r
 } EFI_STRING_TYPE;\r
 \r
 typedef struct {\r
-  ///\r
-  /// The HII handle of the string pack, which can be used to retrieve the string. \r
-  /// It is a dynamic value that may not be the same for different boots.\r
-  ///\r
-  FRAMEWORK_EFI_HII_HANDLE  Handle;\r
-  ///\r
-  /// When combined with the HII handle, the string token can be used to retrieve the\r
-  /// string. \r
-  ///\r
-  STRING_REF      Token;\r
+  FRAMEWORK_EFI_HII_HANDLE  Handle;  ///< The HII handle of the string pack, which can be\r
+                                     ///< used to retrieve the string. It is a dynamic value\r
+                                     ///< that may not be the same for different boots.\r
+  STRING_REF      Token;             ///< When combined with the HII handle, the string \r
+                                     ///< token can be used to retrieve the string.\r
+\r
 } EFI_STATUS_CODE_STRING_TOKEN;\r
 \r
 typedef union {\r
-  ///\r
-  /// ASCII formatted string.\r
-  ///\r
-  CHAR8                         *Ascii;\r
-  ///\r
-  /// Unicode formatted string.\r
-  ///\r
-  CHAR16                        *Unicode;\r
-  ///\r
-  /// HII handle/token pair.\r
-  ///\r
-  EFI_STATUS_CODE_STRING_TOKEN  Hii;\r
+  CHAR8                         *Ascii;   ///< ASCII formatted string.\r
+  CHAR16                        *Unicode; ///< Unicode formatted string.\r
+  EFI_STATUS_CODE_STRING_TOKEN  Hii;      ///< HII handle/token pair.\r
 } EFI_STATUS_CODE_STRING;\r
 \r
 typedef struct {\r
-  ///\r
-  /// The data header identifying the data. The HeaderSize should be sizeof\r
-  /// (EFI_STATUS_CODE_DATA).\r
-  /// The Size should be sizeof(EFI_STATUS_CODE_STRING_DATA) - HeaderSize.\r
-  /// The Type should be EFI_STATUS_CODE_DATA_TYPE_STRING_GUID.\r
-  ///\r
-  EFI_STATUS_CODE_DATA                          DataHeader;\r
-  ///\r
-  /// Specifies if the string is ASCII or Unicode.\r
-  ///\r
-  EFI_STRING_TYPE                               StringType;\r
-  ///\r
-  /// A pointer to a null-terminated ASCII or Unicode string.\r
-  ///\r
-  EFI_STATUS_CODE_STRING                        String;\r
+  EFI_STATUS_CODE_DATA           DataHeader; ///< The data header identifying the data.\r
+  EFI_STRING_TYPE                StringType; ///< Specifies if the string is ASCII or Unicode.\r
+  EFI_STATUS_CODE_STRING         String;     ///< A pointer to a null-terminated ASCII or Unicode string.\r
 } EFI_STATUS_CODE_STRING_DATA;\r
 #pragma pack()\r
 \r