From 9199040cb29991c1ee4259a50cab8dd8f1cc96c2 Mon Sep 17 00:00:00 2001
From: yshang1 <yshang1@6f19259b-4bc3-4df7-8a09-765794883524>
Date: Mon, 21 Jul 2008 07:26:20 +0000
Subject: [PATCH] Code Scrub of MdePkg/Inlcude/Library

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5533 6f19259b-4bc3-4df7-8a09-765794883524
---
 MdePkg/Include/Library/FvbServiceLib.h             | 8 ++++++++
 MdePkg/Include/Library/HiiLib.h                    | 2 --
 MdePkg/Include/Library/IfrSupportLib.h             | 4 +---
 MdePkg/Include/Library/MemoryAllocationLib.h       | 9 +++++++++
 MdePkg/Include/Library/PciCf8Lib.h                 | 4 ++--
 MdePkg/Include/Library/PciExpressLib.h             | 4 ++--
 MdePkg/Include/Library/PciLib.h                    | 2 +-
 MdePkg/Include/Library/PeiPiLib.h                  | 3 +--
 MdePkg/Include/Library/ScsiLib.h                   | 1 +
 MdePkg/Include/Library/UefiApplicationEntryPoint.h | 5 -----
 MdePkg/Include/Library/UefiLib.h                   | 8 ++++++++
 MdePkg/Include/Library/UsbLib.h                    | 1 +
 12 files changed, 34 insertions(+), 17 deletions(-)

diff --git a/MdePkg/Include/Library/FvbServiceLib.h b/MdePkg/Include/Library/FvbServiceLib.h
index 19854753f4..4299f0a4de 100644
--- a/MdePkg/Include/Library/FvbServiceLib.h
+++ b/MdePkg/Include/Library/FvbServiceLib.h
@@ -32,6 +32,7 @@
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbReadBlock (
   IN UINTN                                        Instance,
   IN EFI_LBA                                      Lba,
@@ -58,6 +59,7 @@ EfiFvbReadBlock (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbWriteBlock (
   IN UINTN                                        Instance,
   IN EFI_LBA                                      Lba,
@@ -78,6 +80,7 @@ EfiFvbWriteBlock (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbEraseBlock (
   IN UINTN                                Instance,
   IN EFI_LBA                              Lba
@@ -97,6 +100,7 @@ EfiFvbEraseBlock (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbGetVolumeAttributes (
   IN UINTN                                Instance,
   OUT EFI_FVB_ATTRIBUTES                  *Attributes
@@ -118,6 +122,7 @@ EfiFvbGetVolumeAttributes (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbSetVolumeAttributes (
   IN     UINTN                                Instance,
   IN OUT EFI_FVB_ATTRIBUTES                   *Attributes
@@ -137,6 +142,7 @@ EfiFvbSetVolumeAttributes (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbGetPhysicalAddress (
   IN UINTN                                Instance,
   OUT EFI_PHYSICAL_ADDRESS                *BaseAddress
@@ -160,6 +166,7 @@ EfiFvbGetPhysicalAddress (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbGetBlockSize (
   IN UINTN                                        Instance,
   IN EFI_LBA                                      Lba,
@@ -184,6 +191,7 @@ EfiFvbGetBlockSize (
 
 **/
 EFI_STATUS
+EFIAPI
 EfiFvbEraseCustomBlockRange (
   IN UINTN                                Instance,
   IN EFI_LBA                              StartLba,
diff --git a/MdePkg/Include/Library/HiiLib.h b/MdePkg/Include/Library/HiiLib.h
index ba22b01db7..012a7b8052 100644
--- a/MdePkg/Include/Library/HiiLib.h
+++ b/MdePkg/Include/Library/HiiLib.h
@@ -90,8 +90,6 @@ HiiLibAddPackages (
   @param  HiiHandle                The handle that was previously registered to the data base that is requested for removal.
                                              List later.
 
-  @return  VOID
-
 **/
 VOID
 EFIAPI
diff --git a/MdePkg/Include/Library/IfrSupportLib.h b/MdePkg/Include/Library/IfrSupportLib.h
index 953cd47314..36c3385c6e 100644
--- a/MdePkg/Include/Library/IfrSupportLib.h
+++ b/MdePkg/Include/Library/IfrSupportLib.h
@@ -427,8 +427,7 @@ CreateStringOpCode (
 
   @param Str     String to be converted
 
-  @retval VOID
-  
+ 
 **/
 VOID
 EFIAPI
@@ -653,7 +652,6 @@ SetBrowserData (
   @retval EFI_INVALID_PARAMETER  One of the parameters was invalid.
 
 **/
-
 EFI_STATUS
 EFIAPI
 IfrLibCreatePopUp (
diff --git a/MdePkg/Include/Library/MemoryAllocationLib.h b/MdePkg/Include/Library/MemoryAllocationLib.h
index 8f6d1ec16a..e613c7335a 100644
--- a/MdePkg/Include/Library/MemoryAllocationLib.h
+++ b/MdePkg/Include/Library/MemoryAllocationLib.h
@@ -617,6 +617,15 @@ FreeAlignedPool (
   IN VOID   *Buffer
   );
 
+
+/**
+  Frees buffer that were previously allocated with one of the
+  memory allocation functions in the Memory Allocation Library.
+
+  @param  Buffer                Pointer to the buffer of pages
+                                to free.
+
+**/
 VOID
 EFIAPI
 SafeFreePool (
diff --git a/MdePkg/Include/Library/PciCf8Lib.h b/MdePkg/Include/Library/PciCf8Lib.h
index 41491f01a2..7ae59e67ea 100644
--- a/MdePkg/Include/Library/PciCf8Lib.h
+++ b/MdePkg/Include/Library/PciCf8Lib.h
@@ -1000,7 +1000,7 @@ PciCf8BitFieldAndThenOr32 (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer receiving the data read.
 
-  @return Size
+  @return Size read from StartAddress.
 
 **/
 UINTN
@@ -1033,7 +1033,7 @@ PciCf8ReadBuffer (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer containing the data to write.
 
-  @return Size
+  @return Size written to StartAddress.
 
 **/
 UINTN
diff --git a/MdePkg/Include/Library/PciExpressLib.h b/MdePkg/Include/Library/PciExpressLib.h
index de69b810f6..5e70735237 100644
--- a/MdePkg/Include/Library/PciExpressLib.h
+++ b/MdePkg/Include/Library/PciExpressLib.h
@@ -970,7 +970,7 @@ PciExpressBitFieldAndThenOr32 (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer receiving the data read.
 
-  @return Size
+  @return Size read daata from StartAddress.
 
 **/
 UINTN
@@ -1002,7 +1002,7 @@ PciExpressReadBuffer (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer containing the data to write.
 
-  @return Size
+  @return Size written to StartAddress.
 
 **/
 UINTN
diff --git a/MdePkg/Include/Library/PciLib.h b/MdePkg/Include/Library/PciLib.h
index f8e4b572f9..34e1a24c76 100644
--- a/MdePkg/Include/Library/PciLib.h
+++ b/MdePkg/Include/Library/PciLib.h
@@ -997,7 +997,7 @@ PciReadBuffer (
   @param  Size          Size in bytes of the transfer.
   @param  Buffer        Pointer to a buffer containing the data to write.
 
-  @return Size
+  @return Size written to StartAddress.
 
 **/
 UINTN
diff --git a/MdePkg/Include/Library/PeiPiLib.h b/MdePkg/Include/Library/PeiPiLib.h
index c79552c597..5603689d88 100644
--- a/MdePkg/Include/Library/PeiPiLib.h
+++ b/MdePkg/Include/Library/PeiPiLib.h
@@ -35,8 +35,7 @@
                                           parent firmware volume name and firmware volume file. If it did not originally come
                                           from a firmware file, these should be NULL
   
-    @retval  VOID
-  
+ 
   **/
 
 VOID
diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h
index c7677fe7d4..13a4bb3634 100644
--- a/MdePkg/Include/Library/ScsiLib.h
+++ b/MdePkg/Include/Library/ScsiLib.h
@@ -248,6 +248,7 @@ ScsiRequestSenseCommand (
 
 **/
 EFI_STATUS
+EFIAPI
 ScsiReadCapacityCommand (
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,
   IN  UINT64                Timeout,
diff --git a/MdePkg/Include/Library/UefiApplicationEntryPoint.h b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
index ff8b5b241e..8ab07d9653 100644
--- a/MdePkg/Include/Library/UefiApplicationEntryPoint.h
+++ b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
@@ -62,8 +62,6 @@ EfiMain (
 
   @param  Status Status returned by the application that is exiting.
   
-  @retval VOID
-
 **/
 VOID
 EFIAPI
@@ -79,8 +77,6 @@ Exit (
   @param  ImageHandle ImageHandle of the loaded driver.
   @param  SystemTable Pointer to the EFI System Table.
   
-  @retval VOID
-
 **/
 VOID
 EFIAPI
@@ -97,7 +93,6 @@ ProcessLibraryConstructorList (
   @param  ImageHandle ImageHandle of the loaded driver.
   @param  SystemTable Pointer to the EFI System Table.
 
-  @retval VOID
 **/
 VOID
 EFIAPI
diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index 7daa23be48..4ad8d413cf 100644
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -772,6 +772,8 @@ EfiGetNameGuidFromFwVolDevicePathNode (
   @param ...      VARARG list consumed to process Format.
   If Format is NULL, then ASSERT().
   If Format is not aligned on a 16-bit boundary, then ASSERT().
+  
+  @return Number of Unicode characters printed to ConOut.
 
 **/
 UINTN
@@ -795,6 +797,8 @@ Print (
   @param ...      VARARG list consumed to process Format.
   If Format is NULL, then ASSERT().
   If Format is not aligned on a 16-bit boundary, then ASSERT().
+  
+  @return Number of Unicode characters printed to StdErr.
 
 **/
 UINTN
@@ -818,6 +822,8 @@ ErrorPrint (
   @param ...      VARARG list consumed to process Format.
   If Format is NULL, then ASSERT().
   If Format is not aligned on a 16-bit boundary, then ASSERT().
+  
+  @return Number of ASCII characters printed to ConOut.
 
 **/
 UINTN
@@ -841,6 +847,8 @@ AsciiPrint (
   @param ...      VARARG list consumed to process Format.
   If Format is NULL, then ASSERT().
   If Format is not aligned on a 16-bit boundary, then ASSERT().
+  
+  @return Number of ASCII characters printed to ConErr.
 
 **/
 UINTN
diff --git a/MdePkg/Include/Library/UsbLib.h b/MdePkg/Include/Library/UsbLib.h
index 6b78322c11..a77a855230 100644
--- a/MdePkg/Include/Library/UsbLib.h
+++ b/MdePkg/Include/Library/UsbLib.h
@@ -212,6 +212,7 @@ UsbGetReportRequest (
 
 **/
 EFI_STATUS
+EFIAPI
 UsbGetDescriptor (
   IN  EFI_USB_IO_PROTOCOL     *UsbIo,
   IN  UINT16                  Value,
-- 
2.39.2