Code Scrub for EdkDxePrintLib.

[mirror_edk2.git] / MdeModulePkg / Library / EdkDxePrintLib / PrintLib.c

diff --git a/MdeModulePkg/Library/EdkDxePrintLib/PrintLib.c b/MdeModulePkg/Library/EdkDxePrintLib/PrintLib.c
index 03633f6440cea93eaca361447328f64ea7f0ef5d..18ea2349d25fcffa074334277ac1068161f9a398 100644 (file)
--- a/MdeModulePkg/Library/EdkDxePrintLib/PrintLib.c
+++ b/MdeModulePkg/Library/EdkDxePrintLib/PrintLib.c
@@ -1,4 +1,5 @@
 /** @file\r
+  Instance of Print Library based on EFI_PRINT2_PROTOCOL.\r
 \r
   Implement the print library instance by wrap the interface \r
   provided in the Print protocol. This protocol is defined as the internal\r
@@ -25,12 +26,20 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 \r
 EFI_PRINT2_PROTOCOL  *gPrintProtocol = NULL;\r
 \r
+/**\r
+  Internal function to locate the EFI_PRINT2_PROTOCOL.\r
+\r
+  @retval  EFI_SUCCESS   EFI_PRINT2_PROTOCOL is successfuly located.\r
+  @retval  EFI_NOT_FOUND EFI_PRINT2_PROTOCOL cannot be found.\r
+\r
+**/\r
 EFI_STATUS\r
 EFIAPI\r
 InternalLocatePrintProtocol (\r
+  VOID\r
   )\r
 {\r
-  EFI_STATUS  Status = EFI_SUCCESS;\r
+  EFI_STATUS  Status;\r
 \r
   if (gPrintProtocol == NULL) {\r
     Status = gBS->LocateProtocol (\r
@@ -124,7 +133,8 @@ UnicodeVSPrint (
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  \r
+  @param  ...             Variable argument list based on the contents of the format string.\r
+\r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -220,6 +230,7 @@ UnicodeVSPrintAsciiFormat (
                           Unicode string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
+  @param  ...             Variable argument list based on the contents of the format string.\r
   \r
   @return The number of Unicode characters in the produced output buffer not including the\r
           Null-terminator.\r
@@ -371,7 +382,8 @@ AsciiVSPrint (
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  \r
+  @param  ...             Variable argument list based on the contents of the format string.\r
+\r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r
@@ -467,7 +479,8 @@ AsciiVSPrintUnicodeFormat (
                           ASCII string.\r
   @param  BufferSize      The size, in bytes, of the output buffer specified by StartOfBuffer.\r
   @param  FormatString    Null-terminated Unicode format string.\r
-  \r
+  @param  ...             Variable argument list based on the contents of the format string.\r
+\r
   @return The number of ASCII characters in the produced output buffer not including the\r
           Null-terminator.\r
 \r