Function headers in .h and .c files synchronized with spec

[mirror_edk2.git] / MdePkg / Library / BasePrintLib / PrintLibInternal.h

diff --git a/MdePkg/Library/BasePrintLib/PrintLibInternal.h b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
index 164de3c3d0ab588447524709d7b099c7e0b9cd67..417d3e60f0c112cf2bf838c65abb6baccb21009b 100644 (file)
--- a/MdePkg/Library/BasePrintLib/PrintLibInternal.h
+++ b/MdePkg/Library/BasePrintLib/PrintLibInternal.h
@@ -1,7 +1,7 @@
 /** @file\r
-  Print Library Internal Functions.\r
+  Base Print Library instance Internal Functions definition.\r
 \r
-  Copyright (c) 2006 - 2007, Intel Corporation\r
+  Copyright (c) 2006 - 2008, Intel Corporation\r
   All rights reserved. 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
@@ -10,29 +10,24 @@
   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
-  Module Name:  PrintLibInternal.h\r
-\r
 **/\r
 \r
-#ifndef __PRINT_LIB_INTERNAL_H\r
-#define __PRINT_LIB_INTERNAL_H\r
+#ifndef __PRINT_LIB_INTERNAL_H__\r
+#define __PRINT_LIB_INTERNAL_H__\r
+\r
+#include <Base.h>\r
+#include <Library/PrintLib.h>\r
+#include <Library/BaseLib.h>\r
+#include <Library/DebugLib.h>\r
 \r
-//\r
-// Include common header file for this module.\r
-//\r
-#include "CommonHeader.h"\r
 \r
 //\r
 // Print primitives\r
 //\r
-//#define LEFT_JUSTIFY      0x01\r
 #define PREFIX_SIGN       0x02\r
 #define PREFIX_BLANK      0x04\r
-//#define COMMA_TYPE        0x08\r
 #define LONG_TYPE         0x10\r
-//#define PREFIX_ZERO       0x20\r
 #define OUTPUT_UNICODE    0x40\r
-//#define RADIX_HEX         0x80\r
 #define FORMAT_UNICODE    0x100\r
 #define PAD_TO_WIDTH      0x200\r
 #define ARGUMENT_UNICODE  0x400\r
@@ -92,20 +87,21 @@ BasePrintLibVSPrint (
   VA_LIST is used this rountine allows the nesting of Vararg routines. Thus \r
   this is the main print working routine\r
 \r
-  @param  Buffer        Character buffer to print the results of the parsing\r
+  @param  StartOfBuffer Character buffer to print the results of the parsing\r
                         of Format into.\r
   @param  BufferSize    Maximum number of characters to put into buffer.\r
                         Zero means no limit.\r
   @param  Flags         Intial flags value.\r
                         Can only have FORMAT_UNICODE and OUTPUT_UNICODE set\r
   @param  FormatString  Null-terminated format string.\r
+  @param  ...           The variable argument list.\r
 \r
   @return Number of characters printed.\r
 \r
 **/\r
 UINTN\r
 BasePrintLibSPrint (\r
-  OUT CHAR8        *Buffer,\r
+  OUT CHAR8        *StartOfBuffer,\r
   IN  UINTN        BufferSize,\r
   IN  UINTN        Flags,\r
   IN  CONST CHAR8  *FormatString,\r
@@ -124,16 +120,16 @@ BasePrintLibSPrint (
   @param  Character   Character to be placed into Buffer.\r
   @param  Increment   Character increment in Buffer.\r
 \r
-  @return Number of characters printed.\r
+  @return Buffer      Buffer filled with the input Character.\r
 \r
 **/\r
 CHAR8 *\r
 BasePrintLibFillBuffer (\r
-  CHAR8   *Buffer,\r
-  CHAR8   *EndBuffer,\r
-  INTN    Length,\r
-  UINTN   Character,\r
-  INTN    Increment\r
+  OUT CHAR8   *Buffer,\r
+  IN  CHAR8   *EndBuffer,\r
+  IN  INTN    Length,\r
+  IN  UINTN   Character,\r
+  IN  INTN    Increment\r
   );\r
 \r
 /**\r
@@ -149,7 +145,6 @@ BasePrintLibFillBuffer (
 \r
 **/\r
 UINTN\r
-EFIAPI\r
 BasePrintLibValueToString (\r
   IN OUT CHAR8  *Buffer, \r
   IN INT64      Value, \r