MdePkg: Clean up source files

[mirror_edk2.git] / MdePkg / Include / Protocol / HiiImage.h

diff --git a/MdePkg/Include/Protocol/HiiImage.h b/MdePkg/Include/Protocol/HiiImage.h
index 1d42bfa71e4c97db47583b123ba485149c0d0f57..f219ef47c79ed6cddc726ce38a545f3031f92acc 100644 (file)
--- a/MdePkg/Include/Protocol/HiiImage.h
+++ b/MdePkg/Include/Protocol/HiiImage.h
@@ -1,14 +1,14 @@
 /** @file\r
   The file provides services to access to images in the images database.\r
 /** @file\r
   The file provides services to access to images in the images database.\r

-  \r
-  Copyright (c) 2006 - 2016, Intel Corporation. All rights reserved.<BR>\r
-  This program and the accompanying materials                          \r
-  are licensed and made available under the terms and conditions of the BSD License         \r
-  which accompanies this distribution.  The full text of the license may be found at        \r
-  http://opensource.org/licenses/bsd-license.php                                            \r

 \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) 2006 - 2018, Intel Corporation. All rights reserved.<BR>\r
+  This program and the accompanying materials\r
+  are licensed and made available under the terms and conditions of the BSD License\r
+  which accompanies this distribution.  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

 \r
 **/\r
 \r
 \r
 **/\r
 \r


@@ -25,18 +25,18 @@ typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL;
 \r
 ///\r
 /// Flags in EFI_IMAGE_INPUT\r
 \r
 ///\r
 /// Flags in EFI_IMAGE_INPUT\r

-/// \r
+///\r

 #define EFI_IMAGE_TRANSPARENT 0x00000001\r
 \r
 /**\r
 #define EFI_IMAGE_TRANSPARENT 0x00000001\r
 \r
 /**\r

-   \r
+\r

   Definition of EFI_IMAGE_INPUT.\r
   Definition of EFI_IMAGE_INPUT.\r

-   \r
+\r

   @param Flags  Describe image characteristics. If\r
                 EFI_IMAGE_TRANSPARENT is set, then the image was\r
                 designed for transparent display.\r
 \r
   @param Flags  Describe image characteristics. If\r
                 EFI_IMAGE_TRANSPARENT is set, then the image was\r
                 designed for transparent display.\r
 \r

-  @param Width  Image width, in pixels. \r
+  @param Width  Image width, in pixels.\r

 \r
   @param Height Image height, in pixels.\r
 \r
 \r
   @param Height Image height, in pixels.\r
 \r


@@ -44,7 +44,7 @@ typedef struct _EFI_HII_IMAGE_PROTOCOL EFI_HII_IMAGE_PROTOCOL;
                 top-to-bottom. The size of the bitmap is\r
                 Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).\r
 \r
                 top-to-bottom. The size of the bitmap is\r
                 Width*Height*sizeof(EFI_GRAPHICS_OUTPUT_BLT_PIXEL).\r
 \r

-   \r
+\r

 **/\r
 typedef struct _EFI_IMAGE_INPUT {\r
   UINT32                          Flags;\r
 **/\r
 typedef struct _EFI_IMAGE_INPUT {\r
   UINT32                          Flags;\r


@@ -60,8 +60,8 @@ typedef struct _EFI_IMAGE_INPUT {
   owned by PackageList, and returns a new image identifier\r
   (ImageId).\r
 \r
   owned by PackageList, and returns a new image identifier\r
   (ImageId).\r
 \r

-  @param This        A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
-  \r
+  @param This        A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
+\r

   @param PackageList Handle of the package list where this image will be added.\r
 \r
   @param ImageId     On return, contains the new image id, which is\r
   @param PackageList Handle of the package list where this image will be added.\r
 \r
   @param ImageId     On return, contains the new image id, which is\r


@@ -71,9 +71,9 @@ typedef struct _EFI_IMAGE_INPUT {
 \r
   @retval EFI_SUCCESS             The new image was added\r
                                   successfully\r
 \r
   @retval EFI_SUCCESS             The new image was added\r
                                   successfully\r

-  \r
+\r

   @retval EFI_OUT_OF_RESOURCES    Could not add the image.\r
   @retval EFI_OUT_OF_RESOURCES    Could not add the image.\r

-  \r
+\r

   @retval EFI_INVALID_PARAMETER   Image is NULL or ImageId is\r
                                   NULL.\r
 \r
   @retval EFI_INVALID_PARAMETER   Image is NULL or ImageId is\r
                                   NULL.\r
 \r


@@ -100,21 +100,21 @@ EFI_STATUS
   updated to the size of buffer actually required to hold the\r
   image.\r
 \r
   updated to the size of buffer actually required to hold the\r
   image.\r
 \r

-  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
-  \r
+  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
+\r

   @param PackageList  The package list in the HII database to\r
                       search for the specified image.\r
   @param PackageList  The package list in the HII database to\r
                       search for the specified image.\r

-  \r
+\r

   @param ImageId      The image's id, which is unique within\r
                       PackageList.\r
   @param ImageId      The image's id, which is unique within\r
                       PackageList.\r

-  \r
+\r

   @param Image        Points to the new image.\r
   @param Image        Points to the new image.\r

-  \r
+\r

   @retval EFI_SUCCESS            The image was returned successfully.\r
 \r
   @retval EFI_NOT_FOUND          The image specified by ImageId is not\r
                                  available. Or The specified PackageList is not in the database.\r
   @retval EFI_SUCCESS            The image was returned successfully.\r
 \r
   @retval EFI_NOT_FOUND          The image specified by ImageId is not\r
                                  available. Or The specified PackageList is not in the database.\r

-  \r
+\r

   @retval EFI_INVALID_PARAMETER  The Image or Langugae was NULL.\r
   @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there was not\r
                                  enough memory.\r
   @retval EFI_INVALID_PARAMETER  The Image or Langugae was NULL.\r
   @retval EFI_OUT_OF_RESOURCES   The bitmap could not be retrieved because there was not\r
                                  enough memory.\r


@@ -131,12 +131,12 @@ EFI_STATUS
 );\r
 \r
 /**\r
 );\r
 \r
 /**\r

-   \r
+\r

   This function updates the image specified by ImageId in the\r
   specified PackageListHandle to the image specified by Image.\r
 \r
 \r
   This function updates the image specified by ImageId in the\r
   specified PackageListHandle to the image specified by Image.\r
 \r
 \r

-  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
+  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r

 \r
   @param PackageList  The package list containing the images.\r
 \r
 \r
   @param PackageList  The package list containing the images.\r
 \r


@@ -145,10 +145,10 @@ EFI_STATUS
   @param Image        Points to the image.\r
 \r
   @retval EFI_SUCCESS           The image was successfully updated.\r
   @param Image        Points to the image.\r
 \r
   @retval EFI_SUCCESS           The image was successfully updated.\r

-  \r
+\r

   @retval EFI_NOT_FOUND         The image specified by ImageId is not in the database.\r
   @retval EFI_NOT_FOUND         The image specified by ImageId is not in the database.\r

-                                The specified PackageList is not in the database. \r
-  \r
+                                The specified PackageList is not in the database.\r
+\r

   @retval EFI_INVALID_PARAMETER The Image or Language was NULL.\r
 \r
 **/\r
   @retval EFI_INVALID_PARAMETER The Image or Language was NULL.\r
 \r
 **/\r


@@ -176,9 +176,9 @@ typedef UINT32  EFI_HII_DRAW_FLAGS;
 #define EFI_HII_DIRECT_TO_SCREEN        0x00000080\r
 \r
 /**\r
 #define EFI_HII_DIRECT_TO_SCREEN        0x00000080\r
 \r
 /**\r

-   \r
+\r

   Definition of EFI_IMAGE_OUTPUT.\r
   Definition of EFI_IMAGE_OUTPUT.\r

-   \r
+\r

   @param Width  Width of the output image.\r
 \r
   @param Height Height of the output image.\r
   @param Width  Width of the output image.\r
 \r
   @param Height Height of the output image.\r


@@ -201,7 +201,7 @@ typedef struct _EFI_IMAGE_OUTPUT {
 \r
 \r
 /**\r
 \r
 \r
 /**\r

-   \r
+\r

   This function renders an image to a bitmap or the screen using\r
   the specified color and options. It draws the image on an\r
   existing bitmap, allocates a new bitmap or uses the screen. The\r
   This function renders an image to a bitmap or the screen using\r
   the specified color and options. It draws the image on an\r
   existing bitmap, allocates a new bitmap or uses the screen. The\r


@@ -216,14 +216,14 @@ typedef struct _EFI_IMAGE_OUTPUT {
   specified by Bitmap.\r
 \r
 \r
   specified by Bitmap.\r
 \r
 \r

-  @param This       A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
- \r
+  @param This       A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r
+\r

   @param Flags      Describes how the image is to be drawn.\r
                     EFI_HII_DRAW_FLAGS is defined in Related\r
                     Definitions, below.\r
   @param Flags      Describes how the image is to be drawn.\r
                     EFI_HII_DRAW_FLAGS is defined in Related\r
                     Definitions, below.\r

-  \r
-  @param Image      Points to the image to be displayed. \r
-  \r
+\r
+  @param Image      Points to the image to be displayed.\r
+\r

   @param Blt        If this points to a non-NULL on entry, this points\r
                     to the image, which is Width pixels wide and\r
                     Height pixels high. The image will be drawn onto\r
   @param Blt        If this points to a non-NULL on entry, this points\r
                     to the image, which is Width pixels wide and\r
                     Height pixels high. The image will be drawn onto\r


@@ -259,7 +259,7 @@ EFI_STATUS
 );\r
 \r
 /**\r
 );\r
 \r
 /**\r

-   \r
+\r

   This function renders an image as a bitmap or to the screen and\r
   can clip the image. The bitmap is either supplied by the caller\r
   or else is allocated by the function. The images can be drawn\r
   This function renders an image as a bitmap or to the screen and\r
   can clip the image. The bitmap is either supplied by the caller\r
   or else is allocated by the function. The images can be drawn\r


@@ -292,7 +292,7 @@ EFI_STATUS
   directly to the output device specified by Screen. Otherwise the\r
   image will be rendered to the bitmap specified by Bitmap.\r
 \r
   directly to the output device specified by Screen. Otherwise the\r
   image will be rendered to the bitmap specified by Bitmap.\r
 \r

-  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance. \r
+  @param This         A pointer to the EFI_HII_IMAGE_PROTOCOL instance.\r

 \r
   @param Flags        Describes how the image is to be drawn.\r
 \r
 \r
   @param Flags        Describes how the image is to be drawn.\r
 \r


@@ -315,14 +315,14 @@ EFI_STATUS
                       pixel in the image.\r
 \r
   @retval EFI_SUCCESS           The image was successfully updated.\r
                       pixel in the image.\r
 \r
   @retval EFI_SUCCESS           The image was successfully updated.\r

-  \r
+\r

   @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                 buffer for RowInfoArray or Blt.\r
   @retval EFI_OUT_OF_RESOURCES  Unable to allocate an output\r
                                 buffer for RowInfoArray or Blt.\r

-  \r
-  @retval EFI_NOT_FOUND         The image specified by ImageId is not in the database. \r
-                                Or The specified PackageList is not in the database.                            \r
-  \r
-  @retval EFI_INVALID_PARAMETER The Blt was NULL.    \r
+\r
+  @retval EFI_NOT_FOUND         The image specified by ImageId is not in the database.\r
+                                Or The specified PackageList is not in the database.\r
+\r
+  @retval EFI_INVALID_PARAMETER The Blt was NULL.\r

 \r
 **/\r
 typedef\r
 \r
 **/\r
 typedef\r