Clean up ExtendedHiiLib, HiiLib, IfrSupportLib, ExtendedIfrSupportLib for Doxygen...

[mirror_edk2.git] / MdeModulePkg / Library / ExtendedIfrSupportLib / IfrOpCodeCreation.c

diff --git a/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c b/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c
index 686765b90918b0e114813e7ce16c6ec78b802348..1a9926e23bff1ab248904912164b77f815f6e8a1 100644 (file)
--- a/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c
+++ b/MdeModulePkg/Library/ExtendedIfrSupportLib/IfrOpCodeCreation.c
@@ -17,6 +17,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 STATIC EFI_GUID mIfrVendorGuid = EFI_IFR_TIANO_GUID;\r
 \r
+/**\r
+  Create GUIDed opcode for banner. Banner opcode\r
+  EFI_IFR_EXTEND_OP_BANNER is extended opcode specific\r
+  to Intel's implementation.\r
+\r
+  @param  Title                  String ID for title\r
+  @param  LineNumber             Line number for this banner\r
+  @param  Alignment              Alignment for this banner, left, center or right\r
+  @param  Data                   Destination for the created opcode binary\r
+\r
+  @retval EFI_SUCCESS            Opcode create success\r
+  @retval EFI_BUFFER_TOO_SMALL The space reserved in Data field is too small.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 CreateBannerOpCode (\r