From 58380e9c6174f23df78f777b4209c0fd75245cda Mon Sep 17 00:00:00 2001 From: myronporter Date: Wed, 30 Jun 2010 00:13:25 +0000 Subject: Minor grammatical work--mostly adding periods. Items with ONLY period added did not have the heading date changed, but Items with content changes had heading copyright dates updated. Sending separately a list of files missing Doxygen @param and @return information. (PENDING) git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@10615 6f19259b-4bc3-4df7-8a09-765794883524 --- .../UefiDriverEntryPoint/DriverEntryPoint.c | 38 +++++++++++++--------- 1 file changed, 22 insertions(+), 16 deletions(-) (limited to 'MdePkg/Library/UefiDriverEntryPoint') diff --git a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c index c52ed9afa8..17eeaf396c 100644 --- a/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c +++ b/MdePkg/Library/UefiDriverEntryPoint/DriverEntryPoint.c @@ -63,25 +63,28 @@ _DriverUnloadHandler ( /** - The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. + The entry point of PE/COFF Image for a DXE Driver, DXE Runtime Driver, DXE SMM + Driver, or UEFI Driver. This function is the entry point for a DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. This function must call ProcessLibraryConstructorList() and ProcessModuleEntryPointList(). If the return status from ProcessModuleEntryPointList() - is an error status, then ProcessLibraryDestructorList() must be called. The return value - from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount is greater - than zero, then an unload handler must be registered for this image and the unload handler - must invoke ProcessModuleUnloadList(). - If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than _gUefiDriverRevison, - then return EFI_INCOMPATIBLE_VERSION. + is an error status, then ProcessLibraryDestructorList() must be called. The return + value from ProcessModuleEntryPointList() is returned. If _gDriverUnloadImageCount + is greater than zero, then an unload handler must be registered for this image + and the unload handler must invoke ProcessModuleUnloadList(). + If _gUefiDriverRevision is not zero and SystemTable->Hdr.Revision is less than + _gUefiDriverRevison, then return EFI_INCOMPATIBLE_VERSION. - @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. + @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, + DXE SMM Driver, or UEFI Driver. @param SystemTable A pointer to the EFI System Table. - @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver, - or UEFI Driver exited normally. - @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision. + @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM + Driver, or UEFI Driver exited normally. + @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than + SystemTable->Hdr.Revision. @retval Other Return value from ProcessModuleEntryPointList(). **/ @@ -144,14 +147,17 @@ _ModuleEntryPoint ( /** Required by the EBC compiler and identical in functionality to _ModuleEntryPoint(). - This function is required to call _ModuleEntryPoint() passing in ImageHandle, and SystemTable. + This function is required to call _ModuleEntryPoint() passing in ImageHandle, + and SystemTable. - @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE SMM Driver, or UEFI Driver. + @param ImageHandle The image handle of the DXE Driver, DXE Runtime Driver, DXE + SMM Driver, or UEFI Driver. @param SystemTable A pointer to the EFI System Table. - @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM Driver, - or UEFI Driver exited normally. - @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than SystemTable->Hdr.Revision. + @retval EFI_SUCCESS The DXE Driver, DXE Runtime Driver, DXE SMM + Driver, or UEFI Driver exited normally. + @retval EFI_INCOMPATIBLE_VERSION _gUefiDriverRevision is greater than + SystemTable->Hdr.Revision. @retval Other Return value from ProcessModuleEntryPointList(). **/ EFI_STATUS -- cgit v1.2.3