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

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

3 files changed, 10 insertions, 11 deletions

diff --git a/MdePkg/Include/Library/PeiServicesLib.h b/MdePkg/Include/Library/PeiServicesLib.h
index e417870cdb..9714bb8ff1 100644
--- a/MdePkg/Include/Library/PeiServicesLib.h
+++ b/MdePkg/Include/Library/PeiServicesLib.h
@@ -16,7 +16,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __PEI_SERVICES_LIB_H__

 

 /**

-  This service enables a given PEIM to register an interface into the PEI Foundation. 

+  This service enables a given PEIM to register an interface into the PEI Foundation.

 

   @param  PpiList               A pointer to the list of interfaces that the caller shall install.

 

@@ -98,7 +98,7 @@ PeiServicesNotifyPpi (
   );

 

 /**

-  This service enables PEIMs to ascertain the present value of the boot mode.  

+  This service enables PEIMs to ascertain the present value of the boot mode.

 

   @param  BootMode              A pointer to contain the value of the boot mode.

 

@@ -113,7 +113,7 @@ PeiServicesGetBootMode (
   );

 

 /**

-  This service enables PEIMs to update the boot mode variable.    

+  This service enables PEIMs to update the boot mode variable.

 

   @param  BootMode              The value of the boot mode to set.

 

@@ -165,7 +165,7 @@ PeiServicesCreateHob (
 

   @param  Instance              This instance of the firmware volume to find.  The value 0 is the

                                 Boot Firmware Volume (BFV).

-  @param  VolumeHandle          Pointer to the firmware volume header of the volume to return.

+  @param  VolumeHandle          Handle of the firmware volume header of the volume to return.

 

   @retval EFI_SUCCESS           The volume was found.

   @retval EFI_NOT_FOUND         The volume was not found.

@@ -185,7 +185,7 @@ PeiServicesFfsFindNextVolume (
   @param  SearchType            A filter to find files only of this type.

   @param  VolumeHandle          Pointer to the firmware volume header of the volume to search.

                                 This parameter must point to a valid FFS volume.

-  @param  FileHandle            Pointer to the current file from which to begin searching.

+  @param  FileHandle            Handle of the current file from which to begin searching.

 

   @retval EFI_SUCCESS           The file was found.

   @retval EFI_NOT_FOUND         The file was not found.

diff --git a/MdePkg/Include/Library/PostCodeLib.h b/MdePkg/Include/Library/PostCodeLib.h
index 092f7ee15e..86ad1c6761 100644
--- a/MdePkg/Include/Library/PostCodeLib.h
+++ b/MdePkg/Include/Library/PostCodeLib.h
@@ -33,7 +33,7 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 

   @param  Value  The 32-bit value to write to the POST card.

 

-  @return  Value The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

@@ -55,16 +55,16 @@ PostCode (
   value on the status reporting device.  

 

   PostCodeWithDescription()must actively prevent recursion.  If 

-  PostCodeWithDescription() is called while processing another any other 

-  Post Code Library function, then PostCodeWithDescription() 

-  must return Value immediately.

+  PostCodeWithDescription() is called while processing another any other Post 

+  Code Library function, then PostCodeWithDescription() must return Value 

+  immediately.

 

   @param  Value        The 32-bit value to write to the POST card.

   @param  Description  Pointer to an ASCII string that is a description of the 

                        POST code value.  This is an optional parameter that may 

                        be NULL.

 

-  @return  Value       The 32-bit value to write to the POST card.

+  @return The 32-bit value to write to the POST card.

 

 **/

 UINT32

diff --git a/MdePkg/Include/Library/ResourcePublicationLib.h b/MdePkg/Include/Library/ResourcePublicationLib.h
index 542463b88f..59d45b64a0 100644
--- a/MdePkg/Include/Library/ResourcePublicationLib.h
+++ b/MdePkg/Include/Library/ResourcePublicationLib.h
@@ -16,7 +16,6 @@ WITHOUT WARRANTIES OR REPRESENTATIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED.
 #define __RESOURCE_PUBLICATION_LIB__

 

 /**

-  

   Declares the presence of permanent system memory in the platform.

 

   Declares that the system memory buffer specified by MemoryBegin and MemoryLength