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

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

diff --git a/MdePkg/Include/Library/UefiDriverEntryPoint.h b/MdePkg/Include/Library/UefiDriverEntryPoint.h
index 6db6086af01bf74b273203cf14b274fd81a52ae3..54ae03ddefcdcd55c5b67994c2bc8d38305edb2f 100644 (file)
--- a/MdePkg/Include/Library/UefiDriverEntryPoint.h
+++ b/MdePkg/Include/Library/UefiDriverEntryPoint.h
@@ -28,17 +28,18 @@ extern CONST UINT8                    _gDriverUnloadImageCount;
 \r
 \r
 /**\r
-  Enrty point to DXE Driver.\r
+  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. \r
 \r
   This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
-  or UEFI Driver. This function must call ProcessLibraryConstructorList() and\r
+  or UEFI Driver.  This function must call ProcessLibraryConstructorList() and\r
   ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()\r
-  is an error status, then ProcessLibraryDestructorList() must be called. The return\r
-  value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is\r
-  greater than zero, then an unload handler must be registered for this image and the\r
-  unload handler must invoke ProcessModuleUnloadList(). If _gUefiDriverRevision is not\r
-  zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison, then return\r
-  EFI_INCOMPATIBLE_VERSION.\r
+  is an error status, then ProcessLibraryDestructorList() must be called. The return value\r
+  from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater\r
+  than zero, then an unload handler must be registered for this image and the unload handler\r
+  must invoke ProcessModuleUnloadList().\r
+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,\r
+  then return EFI_INCOMPATIBLE_VERSION.\r
+\r
 \r
   @param  ImageHandle  ImageHandle of the loaded driver.\r
   @param  SystemTable  Pointer to the EFI System Table.\r
@@ -57,7 +58,7 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint().\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). \r
 \r
   This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.\r
 \r
@@ -100,7 +101,7 @@ ExitDriver (
 \r
   This function must be called by _ModuleEntryPoint().\r
   This function calls the set of library constructors for the set of library instances\r
-  that a module depends on. This includes library instances that a module depends on\r
+  that a module depends on.  This includes library instances that a module depends on\r
   directly and library instances that a module depends on indirectly through other libraries.  \r
   This function is autogenerated by build tools and those build tools are responsible\r
   for collecting the set of library instances, determine which ones have constructors,\r
@@ -120,7 +121,8 @@ ProcessLibraryConstructorList (
 \r
 \r
 /**\r
-  Autogenerated function that calls the library descructors for all of the module's dependent libraries.\r
+  Autogenerated function that calls the library descructors for all of the module's\r
+  dependent libraries.\r
 \r
   This function may be called by _ModuleEntryPoint() or ExitDriver().\r
   This function calls the set of library destructors for the set of library instances\r

diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
index 68410ba3c9825c411159465ed35fd12c8d041a87..02d7160588c0d3a4f7a54250f4c383f7c3cf7f8f 100644 (file)
--- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
+++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c
@@ -63,13 +63,25 @@ _DriverUnloadHandler (
 \r
 \r
 /**\r
-  Enrty point to DXE Driver.\r
+  The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. \r
+\r
+  This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
+  or UEFI Driver.  This function must call ProcessLibraryConstructorList() and\r
+  ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList()\r
+  is an error status, then ProcessLibraryDestructorList() must be called. The return value\r
+  from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater\r
+  than zero, then an unload handler must be registered for this image and the unload handler\r
+  must invoke ProcessModuleUnloadList().\r
+  If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison,\r
+  then return EFI_INCOMPATIBLE_VERSION.\r
 \r
-  @param  ImageHandle ImageHandle of the loaded driver.\r
-  @param  SystemTable Pointer to the EFI System Table.\r
 \r
-  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
-  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
+  @param  ImageHandle  ImageHandle of the loaded driver.\r
+  @param  SystemTable  Pointer to the EFI System Table.\r
+\r
+  @retval  EFI_SUCCESS               One or more of the drivers returned a success code.\r
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+  @retval  Other                     Return value from ProcessModuleEntryPointList().\r
 \r
 **/\r
 EFI_STATUS\r
@@ -129,14 +141,17 @@ _ModuleEntryPoint (
 \r
 \r
 /**\r
-  Enrty point wrapper of DXE Driver.\r
+  Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). \r
+\r
+  This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable.\r
 \r
   @param  ImageHandle ImageHandle of the loaded driver.\r
   @param  SystemTable Pointer to the EFI System Table.\r
 \r
-  @retval  EFI_SUCCESS One or more of the drivers returned a success code.\r
-  @retval  !EFI_SUCESS The return status from the last driver entry point in the list.\r
-\r
+  @retval  EFI_SUCCESS               The DXE Driver, DXE Runtime Driver, DXE SMM Driver,\r
+                                     or UEFI Driver exited normally.\r
+  @retval  EFI_INCOMPATIBLE_VERSION  _gUefiDriverRevision is greater than SystemTable->Hdr.Revision.\r
+  @retval  Other                     Return value from ProcessModuleEntryPointList().\r
 **/\r
 EFI_STATUS\r
 EFIAPI\r