]> git.proxmox.com Git - mirror_edk2.git/commitdiff
Correct the comment.
authorqwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 21 Jul 2008 12:53:53 +0000 (12:53 +0000)
committerqwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524>
Mon, 21 Jul 2008 12:53:53 +0000 (12:53 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5539 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Library/FvbServiceLib.h
MdePkg/Include/Library/IfrSupportLib.h

index 4299f0a4de1b2845bb0565ed5e2c4dd059b077a4..1618716f447f19c3d2af187d62a1c0ccfbec2d33 100644 (file)
 #define __EDK_FVB_SERVICE_LIB_H__\r
 \r
 /**
-  Reads specified number of bytes into a buffer from the specified block\r
+  Reads specified number of bytes into a buffer from the specified block.\r
 
-  @param[in]     Instance    The FV instance to be read from
+  @param[in]     Instance    The FV instance to be read from.\r
   @param[in]     Lba         The logical block address to be read from
   @param[in]     Offset      Offset into the block at which to begin reading
-  @param[in,out] NumBytes    Pointer that on input contains the total size of\r
+  @param[in, out] NumBytes    Pointer that on input contains the total size of\r
                              the buffer. On output, it contains the total number\r
-                             of bytes read
+                             of bytes read.\r
   @param[in]     Buffer      Pointer to a caller allocated buffer that will be\r
-                             used to hold the data read
+                             used to hold the data read.\r
 
   @retval   EFI_EFI_SUCCESS        Buffer contains data read from FVB
   @retval   EFI_INVALID_PARAMETER  invalid parameter
@@ -43,16 +43,16 @@ EfiFvbReadBlock (
 \r
 \r
 /**
-  Writes specified number of bytes from the input buffer to the block\r
+  Writes specified number of bytes from the input buffer to the block.\r
 
-  @param[in]     Instance    The FV instance to be read from
+  @param[in]     Instance    The FV instance to be read from.\r
   @param[in]     Lba         The logical block address to be write to 
   @param[in]     Offset      Offset into the block at which to begin writing
-  @param[in,out] NumBytes    Pointer that on input contains the total size of\r
+  @param[in, out] NumBytes    Pointer that on input contains the total size of\r
                              the buffer. On output, it contains the total number\r
                              of bytes actually written.
   @param[in]     Buffer      Pointer to a caller allocated buffer that contains\r
-                             the source for the write
+                             the source for the write.\r
 
   @retval   EFI_EFI_SUCCESS        Buffer written to FVB
   @retval   EFI_INVALID_PARAMETER  invalid parameter
@@ -70,10 +70,10 @@ EfiFvbWriteBlock (
 \r
 \r
 /**
-  Erases and initializes a firmware volume block\r
+  Erases and initializes a firmware volume block.\r
 
-  @param[in]     Instance    The FV instance to be erased
-  @param[in]     Lba         The logical block address to be erased
+  @param[in]     Instance    The FV instance to be erased.\r
+  @param[in]     Lba         The logical block address to be erased.\r
 
   @retval   EFI_EFI_SUCCESS        Lba was erased
   @retval   EFI_INVALID_PARAMETER  invalid parameter
@@ -89,11 +89,11 @@ EfiFvbEraseBlock (
 \r
 /**
   Retrieves attributes, insures positive polarity of attribute bits, returns\r
-  resulting attributes in output parameter\r
+  resulting attributes in output parameter.\r
 
-  @param[in]     Instance    The FV instance
+  @param[in]     Instance    The FV instance.\r
   @param[out]    Attributes  The FV instance whose attributes is going to be \r
-                             returned
+                             returned.\r
 
   @retval   EFI_EFI_SUCCESS        Valid Attributes were returned 
   @retval   EFI_INVALID_PARAMETER  invalid parameter
@@ -109,13 +109,13 @@ EfiFvbGetVolumeAttributes (
 \r
 /**
   Modifies the current settings of the firmware volume according to the \r
-  input parameter, and returns the new setting of the volume\r
+  input parameter, and returns the new setting of the volume.\r
 
-  @param[in]     Instance    The FV instance
-  @param[in]     Attributes  On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
+  @param[in]     Instance    The FV instance.\r
+  @param[in, out]Attributes  On input, it is a pointer to EFI_FVB_ATTRIBUTES \r
                              containing the desired firmware volume settings.\r
                              On successful return, it contains the new settings\r
-                             of the firmware volume
+                             of the firmware volume.\r
 
   @retval   EFI_EFI_SUCCESS        Attributes were updated
   @retval   EFI_INVALID_PARAMETER  invalid parameter
@@ -130,7 +130,7 @@ EfiFvbSetVolumeAttributes (
 \r
 \r
 /**
-  Retrieves the physical address of a memory mapped FV\r
+  Retrieves the physical address of a memory mapped FV.\r
 
   @param[in]     Instance    The FV instance
   @param[out]    BaseAddress Pointer to a caller allocated EFI_PHYSICAL_ADDRESS \r
@@ -150,16 +150,16 @@ EfiFvbGetPhysicalAddress (
 \r
 \r
 /**
-  Retrieve the size of a logical block\r
+  Retrieve the size of a logical block.\r
 
   @param[in]     Instance    The FV instance
   @param[in]     Lba         Indicates which block to return the size for.
-  @param[out]    BlockSizze  A pointer to a caller allocated UINTN in which\r
-                             the size of the block is returned
+  @param[out]    BlockSiz  A pointer to a caller allocated UINTN in which\r
+                             the size of the block is returned.\r
   @param[out]    NumOfBlocks a pointer to a caller allocated UINTN in which the\r
                              number of consecutive blocks starting with Lba is\r
                              returned. All blocks in this range have a size of\r
-                             BlockSize
+                             BlockSize.\r
 
   @retval   EFI_EFI_SUCCESS        BlockSize  and NumOfBlocks returned
   @retval   EFI_INVALID_PARAMETER  invalid parameter
@@ -176,14 +176,14 @@ EfiFvbGetBlockSize (
 \r
 \r
 /**
-  Erases and initializes a specified range of a firmware volume\r
+  Erases and initializes a specified range of a firmware volume.\r
 
-  @param[in]     Instance       The FV instance
-  @param[in]     StartLba       The starting logical block index to be erased
+  @param[in]     Instance       The FV instance.\r
+  @param[in]     StartLba       The starting logical block index to be erased.\r
   @param[in]     OffsetStartLba Offset into the starting block at which to \r
-                                begin erasing    
-  @param[in]     LastLba        The last logical block index to be erased
-  @param[in]     OffsetLastLba  Offset into the last block at which to end erasing     
+                                begin erasing.    \r
+  @param[in]     LastLba        The last logical block index to be erased.\r
+  @param[in]     OffsetLastLba  Offset into the last block at which to end erasing.   \r
 
   @retval   EFI_EFI_SUCCESS        Range was erased 
   @retval   EFI_INVALID_PARAMETER  invalid parameter
index 36c3385c6e2811eb00976982e5d27207b8ec3ea6..a187b9e0a6a9390d2e0c8d3369146344b14259ad 100644 (file)
@@ -13,8 +13,8 @@
 
 **/
 
-#ifndef _IFR_SUPPORT_LIBRARY_H
-#define _IFR_SUPPORT_LIBRARY_H
+#ifndef _IFR_SUPPORT_LIBRARY_H_
+#define _IFR_SUPPORT_LIBRARY_H_
 
 
 #include <Protocol/HiiFont.h>