Code Scrub of MdePkg/Inlcude/Library

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5533 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/MdePkg/Include/Library/FvbServiceLib.h b/MdePkg/Include/Library/FvbServiceLib.h
index 19854753f4bcc8a72b542eb3f6a70e034738cef6..4299f0a4de1b2845bb0565ed5e2c4dd059b077a4 100644 (file)
--- a/MdePkg/Include/Library/FvbServiceLib.h
+++ b/MdePkg/Include/Library/FvbServiceLib.h
@@ -32,6 +32,7 @@
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbReadBlock (\r
   IN UINTN                                        Instance,\r
   IN EFI_LBA                                      Lba,\r
@@ -58,6 +59,7 @@ EfiFvbReadBlock (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbWriteBlock (\r
   IN UINTN                                        Instance,\r
   IN EFI_LBA                                      Lba,\r
@@ -78,6 +80,7 @@ EfiFvbWriteBlock (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbEraseBlock (\r
   IN UINTN                                Instance,\r
   IN EFI_LBA                              Lba\r
@@ -97,6 +100,7 @@ EfiFvbEraseBlock (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbGetVolumeAttributes (\r
   IN UINTN                                Instance,\r
   OUT EFI_FVB_ATTRIBUTES                  *Attributes\r
@@ -118,6 +122,7 @@ EfiFvbGetVolumeAttributes (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbSetVolumeAttributes (\r
   IN     UINTN                                Instance,\r
   IN OUT EFI_FVB_ATTRIBUTES                   *Attributes\r
@@ -137,6 +142,7 @@ EfiFvbSetVolumeAttributes (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbGetPhysicalAddress (\r
   IN UINTN                                Instance,\r
   OUT EFI_PHYSICAL_ADDRESS                *BaseAddress\r
@@ -160,6 +166,7 @@ EfiFvbGetPhysicalAddress (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbGetBlockSize (\r
   IN UINTN                                        Instance,\r
   IN EFI_LBA                                      Lba,\r
@@ -184,6 +191,7 @@ EfiFvbGetBlockSize (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 EfiFvbEraseCustomBlockRange (\r
   IN UINTN                                Instance,\r
   IN EFI_LBA                              StartLba,\r

diff --git a/MdePkg/Include/Library/HiiLib.h b/MdePkg/Include/Library/HiiLib.h
index ba22b01db7521f568896c17f3677a86f3dec3763..012a7b8052c114df5b5bac45ac02cecd35469683 100644 (file)
--- 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.\r
                                              List later.\r
 \r
-  @return  VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/MdePkg/Include/Library/IfrSupportLib.h b/MdePkg/Include/Library/IfrSupportLib.h
index 953cd47314b5b5f3dc735a54183b5fda8dac80ee..36c3385c6e2811eb00976982e5d27207b8ec3ea6 100644 (file)
--- 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 8f6d1ec16a2bb4ff9e63c68fcee55fbdd7081d13..e613c7335af51474754b124d25e0357a90b4a76c 100644 (file)
--- a/MdePkg/Include/Library/MemoryAllocationLib.h
+++ b/MdePkg/Include/Library/MemoryAllocationLib.h
@@ -617,6 +617,15 @@ FreeAlignedPool (
   IN VOID   *Buffer\r
   );\r
 \r
+\r
+/**\r
+  Frees buffer that were previously allocated with one of the\r
+  memory allocation functions in the Memory Allocation Library.\r
+\r
+  @param  Buffer                Pointer to the buffer of pages\r
+                                to free.\r
+\r
+**/\r
 VOID\r
 EFIAPI\r
 SafeFreePool (\r

diff --git a/MdePkg/Include/Library/PciCf8Lib.h b/MdePkg/Include/Library/PciCf8Lib.h
index 41491f01a2dcb72df02737bcdc1de808b5b82c41..7ae59e67ea2fd4441015dae70b987c5b6cb7fdda 100644 (file)
--- 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.\r
   @param  Buffer        Pointer to a buffer receiving the data read.\r
 \r
-  @return Size\r
+  @return Size read from StartAddress.\r
 \r
 **/\r
 UINTN\r
@@ -1033,7 +1033,7 @@ PciCf8ReadBuffer (
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
-  @return Size\r
+  @return Size written to StartAddress.\r
 \r
 **/\r
 UINTN\r

diff --git a/MdePkg/Include/Library/PciExpressLib.h b/MdePkg/Include/Library/PciExpressLib.h
index de69b810f624524b1e9013bd141b9b15a5963ce4..5e707352370bb233abea526f99a15601ec0a996f 100644 (file)
--- 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.\r
   @param  Buffer        Pointer to a buffer receiving the data read.\r
 \r
-  @return Size\r
+  @return Size read daata from StartAddress.\r
 \r
 **/\r
 UINTN\r
@@ -1002,7 +1002,7 @@ PciExpressReadBuffer (
   @param  Size          Size in bytes of the transfer.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
-  @return Size\r
+  @return Size written to StartAddress.\r
 \r
 **/\r
 UINTN\r

diff --git a/MdePkg/Include/Library/PciLib.h b/MdePkg/Include/Library/PciLib.h
index f8e4b572f9c9cc25393e7d7404bf61095bd4bee2..34e1a24c76e3f72ecb997e225640602b5369ee2a 100644 (file)
--- 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.\r
   @param  Buffer        Pointer to a buffer containing the data to write.\r
 \r
-  @return Size\r
+  @return Size written to StartAddress.\r
 \r
 **/\r
 UINTN\r

diff --git a/MdePkg/Include/Library/PeiPiLib.h b/MdePkg/Include/Library/PeiPiLib.h
index c79552c597ec7fe7c3903cc158e92f27521848c0..5603689d88e0b1e58534919fed88f03e200a9799 100644 (file)
--- 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\r
                                           from a firmware file, these should be NULL\r
   \r
-    @retval  VOID\r
-  \r
+ \r
   **/\r
 \r
 VOID\r

diff --git a/MdePkg/Include/Library/ScsiLib.h b/MdePkg/Include/Library/ScsiLib.h
index c7677fe7d43678624fb8eceb15002cd96616bbe6..13a4bb3634d89cd6678329560621542095b39577 100644 (file)
--- a/MdePkg/Include/Library/ScsiLib.h
+++ b/MdePkg/Include/Library/ScsiLib.h
@@ -248,6 +248,7 @@ ScsiRequestSenseCommand (
 
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 ScsiReadCapacityCommand (\r
   IN  EFI_SCSI_IO_PROTOCOL  *ScsiIo,\r
   IN  UINT64                Timeout,\r

diff --git a/MdePkg/Include/Library/UefiApplicationEntryPoint.h b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
index ff8b5b241ed33699217796bfef34bf6e13a7bf25..8ab07d9653e2f51e141cfaa18d2d3c58a9bde9b0 100644 (file)
--- a/MdePkg/Include/Library/UefiApplicationEntryPoint.h
+++ b/MdePkg/Include/Library/UefiApplicationEntryPoint.h
@@ -62,8 +62,6 @@ EfiMain (
 \r
   @param  Status Status returned by the application that is exiting.\r
   \r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -79,8 +77,6 @@ Exit (
   @param  ImageHandle ImageHandle of the loaded driver.\r
   @param  SystemTable Pointer to the EFI System Table.\r
   \r
-  @retval VOID\r
-\r
 **/\r
 VOID\r
 EFIAPI\r
@@ -97,7 +93,6 @@ ProcessLibraryConstructorList (
   @param  ImageHandle ImageHandle of the loaded driver.\r
   @param  SystemTable Pointer to the EFI System Table.\r
 \r
-  @retval VOID\r
 **/\r
 VOID\r
 EFIAPI\r

diff --git a/MdePkg/Include/Library/UefiLib.h b/MdePkg/Include/Library/UefiLib.h
index 7daa23be48512e6aa75b809eb7f593d58572970c..4ad8d413cf946072c0d26ca2cb75ed4d98e1a5aa 100644 (file)
--- a/MdePkg/Include/Library/UefiLib.h
+++ b/MdePkg/Include/Library/UefiLib.h
@@ -772,6 +772,8 @@ EfiGetNameGuidFromFwVolDevicePathNode (
   @param ...      VARARG list consumed to process Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return Number of Unicode characters printed to ConOut.\r
 \r
 **/\r
 UINTN\r
@@ -795,6 +797,8 @@ Print (
   @param ...      VARARG list consumed to process Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return Number of Unicode characters printed to StdErr.\r
 \r
 **/\r
 UINTN\r
@@ -818,6 +822,8 @@ ErrorPrint (
   @param ...      VARARG list consumed to process Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return Number of ASCII characters printed to ConOut.\r
 \r
 **/\r
 UINTN\r
@@ -841,6 +847,8 @@ AsciiPrint (
   @param ...      VARARG list consumed to process Format.\r
   If Format is NULL, then ASSERT().\r
   If Format is not aligned on a 16-bit boundary, then ASSERT().\r
+  \r
+  @return Number of ASCII characters printed to ConErr.\r
 \r
 **/\r
 UINTN\r

diff --git a/MdePkg/Include/Library/UsbLib.h b/MdePkg/Include/Library/UsbLib.h
index 6b78322c11259c728024b74b7aea5663874da29a..a77a855230e3d156a26d01c02507953b29b1e07a 100644 (file)
--- a/MdePkg/Include/Library/UsbLib.h
+++ b/MdePkg/Include/Library/UsbLib.h
@@ -212,6 +212,7 @@ UsbGetReportRequest (
 \r
 **/\r
 EFI_STATUS\r
+EFIAPI\r
 UsbGetDescriptor (\r
   IN  EFI_USB_IO_PROTOCOL     *UsbIo,\r
   IN  UINT16                  Value,\r