Add in doxygen style comment.

[mirror_edk2.git] / MdeModulePkg / Universal / BdsDxe / Bds.h

diff --git a/MdeModulePkg/Universal/BdsDxe/Bds.h b/MdeModulePkg/Universal/BdsDxe/Bds.h
index d5a25d507e3a0603735d6815404a9e41a2d1ef05..e8a9cb5d5d40751a47fa9a9ae789ff3e666575fc 100644 (file)
--- a/MdeModulePkg/Universal/BdsDxe/Bds.h
+++ b/MdeModulePkg/Universal/BdsDxe/Bds.h
@@ -82,6 +82,21 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
       EFI_BDS_ARCH_PROTOCOL_INSTANCE_SIGNATURE \\r
       )\r
 \r
+/**\r
+\r
+  Show progress bar with title above it. It only works in Graphics mode.\r
+\r
+\r
+  @param TitleForeground Foreground color for Title.\r
+  @param TitleBackground Background color for Title.\r
+  @param Title           Title above progress bar.\r
+  @param ProgressColor   Progress bar color.\r
+  @param Progress        Progress (0-100)\r
+  @param PreviousValue   The previous value of the progress.\r
+\r
+  @retval  EFI_STATUS       Success update the progress bar\r
+\r
+**/\r
 EFI_STATUS\r
 PlatformBdsShowProgress (\r
   IN EFI_GRAPHICS_OUTPUT_BLT_PIXEL TitleForeground,\r