MdeModulePkg: Change OPTIONAL keyword usage style

[mirror_edk2.git] / MdeModulePkg / Include / Library / CustomizedDisplayLib.h

diff --git a/MdeModulePkg/Include/Library/CustomizedDisplayLib.h b/MdeModulePkg/Include/Library/CustomizedDisplayLib.h
index 1689e2c4f693211e59cd9d2ee37c0f5034b7363e..8898350d6bdf889134924d183ed8257f0338adf8 100644 (file)
--- a/MdeModulePkg/Include/Library/CustomizedDisplayLib.h
+++ b/MdeModulePkg/Include/Library/CustomizedDisplayLib.h
@@ -1,14 +1,8 @@
 /** @file\r
   This library class defines a set of interfaces to customize Display module\r
 \r
-Copyright (c) 2013, Intel Corporation. All rights reserved.<BR>\r
-This program and the accompanying materials are licensed and made available under \r
-the terms and conditions of the BSD License that accompanies this distribution.  \r
-The full text of the license may be found at\r
-http://opensource.org/licenses/bsd-license.php.                                            \r
-\r
-THE PROGRAM IS DISTRIBUTED UNDER THE BSD LICENSE ON AN "AS IS" BASIS,                     \r
-WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.\r
+Copyright (c) 2013 - 2018, Intel Corporation. All rights reserved.<BR>\r
+SPDX-License-Identifier: BSD-2-Clause-Patent\r
 \r
 **/\r
 \r
@@ -38,14 +32,14 @@ Statement
 **/\r
 \r
 /**\r
-  This funtion defines Page Frame and Backgroud. \r
-  \r
-  Based on the above layout, it will be responsible for HeaderHeight, FooterHeight, \r
-  StatusBarHeight and Backgroud. And, it will reserve Screen for Statement. \r
+  This funtion defines Page Frame and Backgroud.\r
+\r
+  Based on the above layout, it will be responsible for HeaderHeight, FooterHeight,\r
+  StatusBarHeight and Backgroud. And, it will reserve Screen for Statement.\r
 \r
   @param[in]  FormData             Form Data to be shown in Page.\r
   @param[out] ScreenForStatement   Screen to be used for Statement. (Prompt, Value and Help)\r
-  \r
+\r
   @return Status\r
 **/\r
 EFI_STATUS\r
@@ -59,7 +53,7 @@ DisplayPageFrame (
   Clear Screen to the initial state.\r
 **/\r
 VOID\r
-EFIAPI \r
+EFIAPI\r
 ClearDisplayPage (\r
   VOID\r
   );\r
@@ -68,8 +62,8 @@ ClearDisplayPage (
   This function updates customized key panel's help information.\r
   The library will prepare those Strings for the basic key, ESC, Enter, Up/Down/Left/Right, +/-.\r
   and arrange them in Footer panel.\r
-  \r
-  @param[in]  FormData       Form Data to be shown in Page. FormData has the highlighted statement. \r
+\r
+  @param[in]  FormData       Form Data to be shown in Page. FormData has the highlighted statement.\r
   @param[in]  Statement      The statement current selected.\r
   @param[in]  Selected       Whether or not a tag be selected. TRUE means Enter has hit this question.\r
 **/\r
@@ -84,10 +78,10 @@ RefreshKeyHelp (
 /**\r
   Update status bar.\r
 \r
-  This function updates the status bar on the bottom of menu screen. It just shows StatusBar. \r
+  This function updates the status bar on the bottom of menu screen. It just shows StatusBar.\r
   Original logic in this function should be splitted out.\r
 \r
-  @param[in]  MessageType            The type of message to be shown. InputError or Configuration Changed. \r
+  @param[in]  MessageType            The type of message to be shown. InputError or Configuration Changed.\r
   @param[in]  State                  Show or Clear Message.\r
 **/\r
 VOID\r
@@ -98,24 +92,24 @@ UpdateStatusBar (
   );\r
 \r
 /**\r
-  Create popup window. \r
+  Create popup window.\r
 \r
   This function draws OEM/Vendor specific pop up windows.\r
 \r
   @param[out]  Key    User Input Key\r
   @param       ...    String to be shown in Popup. The variable argument list is terminated by a NULL.\r
-  \r
+\r
 **/\r
 VOID\r
 EFIAPI\r
 CreateDialog (\r
-  OUT EFI_INPUT_KEY  *Key,        OPTIONAL\r
+  OUT EFI_INPUT_KEY  *Key         OPTIONAL,\r
   ...\r
   );\r
 \r
 /**\r
-  Confirm how to handle the changed data. \r
-  \r
+  Confirm how to handle the changed data.\r
+\r
   @return Action BROWSER_ACTION_SUBMIT, BROWSER_ACTION_DISCARD or other values.\r
 **/\r
 UINTN\r
@@ -127,7 +121,7 @@ ConfirmDataChange (
 /**\r
   OEM specifies whether Setup exits Page by ESC key.\r
 \r
-  This function customized the behavior that whether Setup exits Page so that \r
+  This function customized the behavior that whether Setup exits Page so that\r
   system able to boot when configuration is not changed.\r
 \r
   @retval  TRUE     Exits FrontPage\r
@@ -140,14 +134,14 @@ FormExitPolicy (
   );\r
 \r
 /**\r
-  Set Timeout value for a ceratain Form to get user response. \r
-  \r
+  Set Timeout value for a ceratain Form to get user response.\r
+\r
   This function allows to set timeout value on a ceratain form if necessary.\r
-  If timeout is not zero, the form will exit if user has no response in timeout. \r
-  \r
+  If timeout is not zero, the form will exit if user has no response in timeout.\r
+\r
   @param[in]  FormData   Form Data to be shown in Page\r
 \r
-  @return 0     No timeout for this form. \r
+  @return 0     No timeout for this form.\r
   @return > 0   Timeout value in 100 ns units.\r
 **/\r
 UINT64\r
@@ -186,8 +180,8 @@ PrintStringAt (
   @param  Column     The cursor position to print the string at. When it is -1, use current Position.\r
   @param  Row        The cursor position to print the string at. When it is -1, use current Position.\r
   @param  String     String pointer.\r
-  @param  Width      Width for String to be printed. If the print length of String < Width, \r
-                     Space char (L' ') will be used to append String. \r
+  @param  Width      Width for String to be printed. If the print length of String < Width,\r
+                     Space char (L' ') will be used to append String.\r
 \r
   @return Length of string printed to the console\r
 \r