]> git.proxmox.com Git - mirror_edk2.git/blobdiff - MdePkg/Include/Protocol/FormBrowser2.h
MdePkg: Clean up source files
[mirror_edk2.git] / MdePkg / Include / Protocol / FormBrowser2.h
index 867b1e0ed0ac18f231f2cc726294d38c76af4582..13e29d0ccbea2a476513581c442b974a1a904c18 100644 (file)
@@ -1,17 +1,17 @@
 /** @file\r
   This protocol is defined in UEFI spec.\r
-  \r
-  The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to \r
+\r
+  The EFI_FORM_BROWSER2_PROTOCOL is the interface to call for drivers to\r
   leverage the EFI configuration driver interface.\r
-  \r
-Copyright (c) 2006 - 2015, 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
+\r
+Copyright (c) 2006 - 2018, 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
+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
 \r
 **/\r
 \r
@@ -29,11 +29,11 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;
 \r
 \r
 /**\r
-   \r
+\r
   @param LeftColumn   The value that designates the text column\r
                       where the browser window will begin from\r
                       the left-hand side of the screen\r
-                      \r
+\r
   @param RightColumn  The value that designates the text\r
                       column where the browser window will end\r
                       on the right-hand side of the screen.\r
@@ -44,7 +44,7 @@ typedef struct _EFI_FORM_BROWSER2_PROTOCOL   EFI_FORM_BROWSER2_PROTOCOL;
 \r
   @param BottomRow    The value that designates the text row from the\r
                       bottom of the screen where the browser\r
-                      window will end. \r
+                      window will end.\r
 **/\r
 typedef struct {\r
   UINTN   LeftColumn;\r
@@ -69,14 +69,14 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST;
 /**\r
   Initialize the browser to display the specified configuration forms.\r
 \r
-  This function is the primary interface to the internal forms-based browser. \r
-  The forms browser will display forms associated with the specified Handles. \r
-  The browser will select all forms in packages which have the specified Type \r
+  This function is the primary interface to the internal forms-based browser.\r
+  The forms browser will display forms associated with the specified Handles.\r
+  The browser will select all forms in packages which have the specified Type\r
   and (for EFI_HII_PACKAGE_TYPE_GUID) the specified PackageGuid.\r
 \r
   @param This            A pointer to the EFI_FORM_BROWSER2_PROTOCOL instance\r
 \r
-  @param Handles         A pointer to an array of Handles. This value should correspond \r
+  @param Handles         A pointer to an array of Handles. This value should correspond\r
                          to the value of the HII form package that is required to be displayed.\r
 \r
   @param HandleCount     The number of Handles specified in Handle.\r
@@ -90,17 +90,17 @@ typedef UINTN EFI_BROWSER_ACTION_REQUEST;
                          displayable page. If this field has a value of 0x0000, then the Forms Browser will\r
                          render the first enabled form in the form set.\r
 \r
-  @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in \r
+  @param ScreenDimensions Points to recommended form dimensions, including any non-content area, in\r
                           characters.\r
 \r
   @param ActionRequest   Points to the action recommended by the form.\r
 \r
   @retval EFI_SUCCESS           The function completed successfully\r
-  \r
+\r
   @retval EFI_NOT_FOUND         The variable was not found.\r
-  \r
+\r
   @retval EFI_INVALID_PARAMETER One of the parameters has an\r
-                                invalid value.  \r
+                                invalid value.\r
 **/\r
 typedef\r
 EFI_STATUS\r
@@ -126,7 +126,7 @@ EFI_STATUS
 \r
   @param ResultsDataSize  A pointer to the size of the buffer\r
                           associated with ResultsData. On input, the size in\r
-                          bytes of ResultsData. On output, the size of data \r
+                          bytes of ResultsData. On output, the size of data\r
                           returned in ResultsData.\r
 \r
   @param ResultsData    A string returned from an IFR browser or\r
@@ -148,7 +148,7 @@ EFI_STATUS
 \r
   @retval EFI_SUCCESS           The results have been distributed or are\r
                                 awaiting distribution.\r
-  \r
+\r
   @retval EFI_OUT_OF_RESOURCES  The ResultsDataSize specified\r
                                 was too small to contain the\r
                                 results data.\r
@@ -166,7 +166,7 @@ EFI_STATUS
 );\r
 \r
 ///\r
-/// This interface will allow the caller to direct the configuration \r
+/// This interface will allow the caller to direct the configuration\r
 /// driver to use either the HII database or use the passed-in packet of data.\r
 ///\r
 struct _EFI_FORM_BROWSER2_PROTOCOL {\r