Modify all file header to follow doxygen format

[mirror_edk2.git] / IntelFrameworkPkg / Library / FrameworkIfrSupportLib / IfrOpCodeCreation.c

diff --git a/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOpCodeCreation.c b/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOpCodeCreation.c
index 05b123887c1aac20fc83c6bc50e89ef56156fdb6..305532083b0f84d7cda4410de01ee917a2dd75f8 100644 (file)
--- a/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOpCodeCreation.c
+++ b/IntelFrameworkPkg/Library/FrameworkIfrSupportLib/IfrOpCodeCreation.c
@@ -1,4 +1,4 @@
-/*++\r
+/** @file\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
@@ -18,7 +18,7 @@ Abstract:
 \r
 Revision History:\r
 \r
---*/\r
+**/\r
 \r
 //\r
 // Include common header file for this module.\r
@@ -51,13 +51,13 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_SUBTITLE  Subtitle;\r
+  FRAMEWORK_EFI_IFR_SUBTITLE  Subtitle;\r
 \r
-  Subtitle.Header.OpCode  = EFI_IFR_SUBTITLE_OP;\r
-  Subtitle.Header.Length  = sizeof (EFI_IFR_SUBTITLE);\r
+  Subtitle.Header.OpCode  = FRAMEWORK_EFI_IFR_SUBTITLE_OP;\r
+  Subtitle.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_SUBTITLE);\r
   Subtitle.SubTitle       = StringToken;\r
 \r
-  CopyMem (FormBuffer, &Subtitle, sizeof (EFI_IFR_SUBTITLE));\r
+  CopyMem (FormBuffer, &Subtitle, sizeof (FRAMEWORK_EFI_IFR_SUBTITLE));\r
   return EFI_SUCCESS;\r
 }\r
 \r
@@ -100,10 +100,10 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_TEXT  Text;\r
+  FRAMEWORK_EFI_IFR_TEXT  Text;\r
 \r
-  Text.Header.OpCode  = EFI_IFR_TEXT_OP;\r
-  Text.Header.Length  = sizeof (EFI_IFR_TEXT);\r
+  Text.Header.OpCode  = FRAMEWORK_EFI_IFR_TEXT_OP;\r
+  Text.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_TEXT);\r
   Text.Text           = StringToken;\r
 \r
   Text.TextTwo        = StringTokenTwo;\r
@@ -111,7 +111,7 @@ Returns:
   Text.Flags          = Flags;\r
   Text.Key            = Key;\r
 \r
-  CopyMem (FormBuffer, &Text, sizeof (EFI_IFR_TEXT));\r
+  CopyMem (FormBuffer, &Text, sizeof (FRAMEWORK_EFI_IFR_TEXT));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -155,17 +155,17 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_REF Hyperlink;\r
+  FRAMEWORK_EFI_IFR_REF Hyperlink;\r
 \r
-  Hyperlink.Header.OpCode = EFI_IFR_REF_OP;\r
-  Hyperlink.Header.Length = sizeof (EFI_IFR_REF);\r
+  Hyperlink.Header.OpCode = FRAMEWORK_EFI_IFR_REF_OP;\r
+  Hyperlink.Header.Length = sizeof (FRAMEWORK_EFI_IFR_REF);\r
   Hyperlink.FormId        = FormId;\r
   Hyperlink.Prompt        = StringToken;\r
   Hyperlink.Help          = StringTokenTwo;\r
   Hyperlink.Key           = Key;\r
   Hyperlink.Flags         = Flags;\r
 \r
-  CopyMem (FormBuffer, &Hyperlink, sizeof (EFI_IFR_REF));\r
+  CopyMem (FormBuffer, &Hyperlink, sizeof (FRAMEWORK_EFI_IFR_REF));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -218,9 +218,9 @@ Returns:
 --*/\r
 {\r
   UINTN                 Index;\r
-  EFI_IFR_ONE_OF        OneOf;\r
-  EFI_IFR_ONE_OF_OPTION OneOfOption;\r
-  EFI_IFR_END_ONE_OF    EndOneOf;\r
+  FRAMEWORK_EFI_IFR_ONE_OF        OneOf;\r
+  FRAMEWORK_EFI_IFR_ONE_OF_OPTION OneOfOption;\r
+  FRAMEWORK_EFI_IFR_END_ONE_OF    EndOneOf;\r
   UINT8                 *LocalBuffer;\r
 \r
   //\r
@@ -230,8 +230,8 @@ Returns:
     return EFI_DEVICE_ERROR;\r
   }\r
 \r
-  OneOf.Header.OpCode = EFI_IFR_ONE_OF_OP;\r
-  OneOf.Header.Length = sizeof (EFI_IFR_ONE_OF);\r
+  OneOf.Header.OpCode = FRAMEWORK_EFI_IFR_ONE_OF_OP;\r
+  OneOf.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ONE_OF);\r
   OneOf.QuestionId    = QuestionId;\r
   OneOf.Width         = DataWidth;\r
   OneOf.Prompt        = PromptToken;\r
@@ -240,30 +240,30 @@ Returns:
 \r
   LocalBuffer         = (UINT8 *) FormBuffer;\r
 \r
-  CopyMem (LocalBuffer, &OneOf, sizeof (EFI_IFR_ONE_OF));\r
+  CopyMem (LocalBuffer, &OneOf, sizeof (FRAMEWORK_EFI_IFR_ONE_OF));\r
 \r
-  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (EFI_IFR_ONE_OF));\r
+  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (FRAMEWORK_EFI_IFR_ONE_OF));\r
 \r
   for (Index = 0; Index < OptionCount; Index++) {\r
-    OneOfOption.Header.OpCode = EFI_IFR_ONE_OF_OPTION_OP;\r
-    OneOfOption.Header.Length = sizeof (EFI_IFR_ONE_OF_OPTION);\r
+    OneOfOption.Header.OpCode = FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP;\r
+    OneOfOption.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION);\r
 \r
     OneOfOption.Option        = OptionsList[Index].StringToken;\r
     OneOfOption.Value         = OptionsList[Index].Value;\r
     OneOfOption.Flags         = OptionsList[Index].Flags;\r
     OneOfOption.Key           = OptionsList[Index].Key;\r
 \r
-    CopyMem (LocalBuffer, &OneOfOption, sizeof (EFI_IFR_ONE_OF_OPTION));\r
+    CopyMem (LocalBuffer, &OneOfOption, sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION));\r
 \r
-    LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (EFI_IFR_ONE_OF_OPTION));\r
+    LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION));\r
   }\r
 \r
-  EndOneOf.Header.Length  = sizeof (EFI_IFR_END_ONE_OF);\r
-  EndOneOf.Header.OpCode  = EFI_IFR_END_ONE_OF_OP;\r
+  EndOneOf.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF);\r
+  EndOneOf.Header.OpCode  = FRAMEWORK_EFI_IFR_END_ONE_OF_OP;\r
 \r
-  CopyMem (LocalBuffer, &EndOneOf, sizeof (EFI_IFR_END_ONE_OF));\r
+  CopyMem (LocalBuffer, &EndOneOf, sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF));\r
 \r
-  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (EFI_IFR_END_ONE_OF));\r
+  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -313,13 +313,13 @@ Returns:
 --*/\r
 {\r
   UINTN                 Index;\r
-  EFI_IFR_ORDERED_LIST  OrderedList;\r
-  EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
-  EFI_IFR_END_ONE_OF    EndOrderedList;\r
+  FRAMEWORK_EFI_IFR_ORDERED_LIST  OrderedList;\r
+  FRAMEWORK_EFI_IFR_ONE_OF_OPTION OrderedListOption;\r
+  FRAMEWORK_EFI_IFR_END_ONE_OF    EndOrderedList;\r
   UINT8                 *LocalBuffer;\r
 \r
-  OrderedList.Header.OpCode = EFI_IFR_ORDERED_LIST_OP;\r
-  OrderedList.Header.Length = sizeof (EFI_IFR_ORDERED_LIST);\r
+  OrderedList.Header.OpCode = FRAMEWORK_EFI_IFR_ORDERED_LIST_OP;\r
+  OrderedList.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST);\r
   OrderedList.QuestionId    = QuestionId;\r
   OrderedList.MaxEntries    = MaxEntries;\r
   OrderedList.Prompt        = PromptToken;\r
@@ -328,30 +328,30 @@ Returns:
 \r
   LocalBuffer               = (UINT8 *) FormBuffer;\r
 \r
-  CopyMem (LocalBuffer, &OrderedList, sizeof (EFI_IFR_ORDERED_LIST));\r
+  CopyMem (LocalBuffer, &OrderedList, sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST));\r
 \r
-  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (EFI_IFR_ORDERED_LIST));\r
+  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (FRAMEWORK_EFI_IFR_ORDERED_LIST));\r
 \r
   for (Index = 0; Index < OptionCount; Index++) {\r
-    OrderedListOption.Header.OpCode = EFI_IFR_ONE_OF_OPTION_OP;\r
-    OrderedListOption.Header.Length = sizeof (EFI_IFR_ONE_OF_OPTION);\r
+    OrderedListOption.Header.OpCode = FRAMEWORK_EFI_IFR_ONE_OF_OPTION_OP;\r
+    OrderedListOption.Header.Length = sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION);\r
 \r
     OrderedListOption.Option        = OptionsList[Index].StringToken;\r
     OrderedListOption.Value         = OptionsList[Index].Value;\r
     OrderedListOption.Flags         = OptionsList[Index].Flags;\r
     OrderedListOption.Key           = OptionsList[Index].Key;\r
 \r
-    CopyMem (LocalBuffer, &OrderedListOption, sizeof (EFI_IFR_ONE_OF_OPTION));\r
+    CopyMem (LocalBuffer, &OrderedListOption, sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION));\r
 \r
-    LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (EFI_IFR_ONE_OF_OPTION));\r
+    LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (FRAMEWORK_EFI_IFR_ONE_OF_OPTION));\r
   }\r
 \r
-  EndOrderedList.Header.Length  = sizeof (EFI_IFR_END_ONE_OF);\r
-  EndOrderedList.Header.OpCode  = EFI_IFR_END_ONE_OF_OP;\r
+  EndOrderedList.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF);\r
+  EndOrderedList.Header.OpCode  = FRAMEWORK_EFI_IFR_END_ONE_OF_OP;\r
 \r
-  CopyMem (LocalBuffer, &EndOrderedList, sizeof (EFI_IFR_END_ONE_OF));\r
+  CopyMem (LocalBuffer, &EndOrderedList, sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF));\r
 \r
-  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (EFI_IFR_END_ONE_OF));\r
+  LocalBuffer = (UINT8 *) (LocalBuffer + sizeof (FRAMEWORK_EFI_IFR_END_ONE_OF));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -399,7 +399,7 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_CHECKBOX  CheckBox;\r
+  FRAMEWORK_EFI_IFR_CHECKBOX  CheckBox;\r
 \r
   //\r
   // We do not create op-code storage widths for checkbox in excess of 8 bits for now\r
@@ -408,8 +408,8 @@ Returns:
     return EFI_DEVICE_ERROR;\r
   }\r
 \r
-  CheckBox.Header.OpCode  = EFI_IFR_CHECKBOX_OP;\r
-  CheckBox.Header.Length  = sizeof (EFI_IFR_CHECKBOX);\r
+  CheckBox.Header.OpCode  = FRAMEWORK_EFI_IFR_CHECKBOX_OP;\r
+  CheckBox.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_CHECKBOX);\r
   CheckBox.QuestionId     = QuestionId;\r
   CheckBox.Width          = DataWidth;\r
   CheckBox.Prompt         = PromptToken;\r
@@ -418,7 +418,7 @@ Returns:
   CheckBox.Flags          = Flags;\r
   CheckBox.Key            = Key;\r
 \r
-  CopyMem (FormBuffer, &CheckBox, sizeof (EFI_IFR_CHECKBOX));\r
+  CopyMem (FormBuffer, &CheckBox, sizeof (FRAMEWORK_EFI_IFR_CHECKBOX));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -479,7 +479,7 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_NUMERIC Numeric;\r
+  FRAMEWORK_EFI_IFR_NUMERIC Numeric;\r
 \r
   //\r
   // We do not create op-code storage widths for numerics in excess of 16 bits for now\r
@@ -488,8 +488,8 @@ Returns:
     return EFI_DEVICE_ERROR;\r
   }\r
 \r
-  Numeric.Header.OpCode = EFI_IFR_NUMERIC_OP;\r
-  Numeric.Header.Length = sizeof (EFI_IFR_NUMERIC);\r
+  Numeric.Header.OpCode = FRAMEWORK_EFI_IFR_NUMERIC_OP;\r
+  Numeric.Header.Length = sizeof (FRAMEWORK_EFI_IFR_NUMERIC);\r
   Numeric.QuestionId    = QuestionId;\r
   Numeric.Width         = DataWidth;\r
   Numeric.Prompt        = PromptToken;\r
@@ -502,7 +502,7 @@ Returns:
   Numeric.Flags         = Flags;\r
   Numeric.Key           = Key;\r
 \r
-  CopyMem (FormBuffer, &Numeric, sizeof (EFI_IFR_NUMERIC));\r
+  CopyMem (FormBuffer, &Numeric, sizeof (FRAMEWORK_EFI_IFR_NUMERIC));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -555,10 +555,10 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_STRING  String;\r
+  FRAMEWORK_EFI_IFR_STRING  String;\r
 \r
-  String.Header.OpCode  = EFI_IFR_STRING_OP;\r
-  String.Header.Length  = sizeof (EFI_IFR_STRING);\r
+  String.Header.OpCode  = FRAMEWORK_EFI_IFR_STRING_OP;\r
+  String.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_STRING);\r
   String.QuestionId     = QuestionId;\r
   String.Width          = DataWidth;\r
   String.Prompt         = PromptToken;\r
@@ -569,7 +569,7 @@ Returns:
   String.Flags          = Flags;\r
   String.Key            = Key;\r
 \r
-  CopyMem (FormBuffer, &String, sizeof (EFI_IFR_STRING));\r
+  CopyMem (FormBuffer, &String, sizeof (FRAMEWORK_EFI_IFR_STRING));\r
 \r
   return EFI_SUCCESS;\r
 }\r
@@ -604,15 +604,15 @@ Returns:
 \r
 --*/\r
 {\r
-  EFI_IFR_BANNER  Banner;\r
+  FRAMEWORK_EFI_IFR_BANNER  Banner;\r
 \r
-  Banner.Header.OpCode  = EFI_IFR_BANNER_OP;\r
-  Banner.Header.Length  = sizeof (EFI_IFR_BANNER);\r
+  Banner.Header.OpCode  = FRAMEWORK_EFI_IFR_BANNER_OP;\r
+  Banner.Header.Length  = sizeof (FRAMEWORK_EFI_IFR_BANNER);\r
   CopyMem (&Banner.Title, &Title, sizeof (UINT16));\r
   CopyMem (&Banner.LineNumber, &LineNumber, sizeof (UINT16));\r
   Banner.Alignment = Alignment;\r
 \r
-  CopyMem (FormBuffer, &Banner, sizeof (EFI_IFR_BANNER));\r
+  CopyMem (FormBuffer, &Banner, sizeof (FRAMEWORK_EFI_IFR_BANNER));\r
 \r
   return EFI_SUCCESS;\r
 }\r