EmulatorPkg/Win: Fix various typos
Fix various typos in comments and documentation. Cc: Jordan Justen <jordan.l.justen@intel.com> Cc: Andrew Fish <afish@apple.com> Cc: Ray Ni <ray.ni@intel.com> Signed-off-by: Antoine Coeur <coeur@gmx.fr> Reviewed-by: Philippe Mathieu-Daude <philmd@redhat.com> Acked-by: Liming Gao <liming.gao@intel.com> Signed-off-by: Philippe Mathieu-Daude <philmd@redhat.com> Message-Id: <20200207010831.9046-7-philmd@redhat.com>
This commit is contained in:
committed by
mergify[bot]
parent
26cfe2c659
commit
3d6b7fd303
@ -346,7 +346,7 @@ WinNtBlockIoReadBlocks (
|
|||||||
the Event is NULL.
|
the Event is NULL.
|
||||||
@retval EFI_WRITE_PROTECTED The device can not be written to.
|
@retval EFI_WRITE_PROTECTED The device can not be written to.
|
||||||
@retval EFI_NO_MEDIA There is no media in the device.
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||||||
@retval EFI_MEDIA_CHNAGED The MediaId does not matched the current device.
|
@retval EFI_MEDIA_CHANGED The MediaId does not match the current device.
|
||||||
@retval EFI_DEVICE_ERROR The device reported an error while performing the write.
|
@retval EFI_DEVICE_ERROR The device reported an error while performing the write.
|
||||||
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
|
@retval EFI_BAD_BUFFER_SIZE The Buffer was not a multiple of the block size of the device.
|
||||||
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
|
@retval EFI_INVALID_PARAMETER The write request contains LBAs that are not valid,
|
||||||
@ -411,7 +411,7 @@ WinNtBlockIoWriteBlocks (
|
|||||||
@retval EFI_SUCCESS The flush request was queued if Event is not NULL.
|
@retval EFI_SUCCESS The flush request was queued if Event is not NULL.
|
||||||
All outstanding data was written correctly to the
|
All outstanding data was written correctly to the
|
||||||
device if the Event is NULL.
|
device if the Event is NULL.
|
||||||
@retval EFI_DEVICE_ERROR The device reported an error while writting back
|
@retval EFI_DEVICE_ERROR The device reported an error while writing back
|
||||||
the data.
|
the data.
|
||||||
@retval EFI_WRITE_PROTECTED The device cannot be written to.
|
@retval EFI_WRITE_PROTECTED The device cannot be written to.
|
||||||
@retval EFI_NO_MEDIA There is no media in the device.
|
@retval EFI_NO_MEDIA There is no media in the device.
|
||||||
|
@ -391,7 +391,7 @@ GetNextFileNameToken (
|
|||||||
If FileName contains only a single L'\', return TRUE.
|
If FileName contains only a single L'\', return TRUE.
|
||||||
If FileName contains two adjacent L'\', return FALSE.
|
If FileName contains two adjacent L'\', return FALSE.
|
||||||
If FileName conatins L'/' , return FALSE.
|
If FileName conatins L'/' , return FALSE.
|
||||||
If FielName contains more than two dots seperated with other FileName characters
|
If FileName contains more than two dots separated with other FileName characters
|
||||||
by L'\', return FALSE. For example, L'.\...\filename.txt' is invalid path name. But L'..TwoDots\filename.txt' is valid path name.
|
by L'\', return FALSE. For example, L'.\...\filename.txt' is invalid path name. But L'..TwoDots\filename.txt' is valid path name.
|
||||||
|
|
||||||
@param FileName The File Name String to check.
|
@param FileName The File Name String to check.
|
||||||
|
@ -78,7 +78,7 @@ typedef struct {
|
|||||||
UINT32 Width;
|
UINT32 Width;
|
||||||
UINT32 Height;
|
UINT32 Height;
|
||||||
//
|
//
|
||||||
// This screen is used to redraw the scree when windows events happen. It's
|
// This screen is used to redraw the screen when windows events happen. It's
|
||||||
// updated in the main thread and displayed in the windows thread.
|
// updated in the main thread and displayed in the windows thread.
|
||||||
//
|
//
|
||||||
BITMAPV4HEADER *VirtualScreenInfo;
|
BITMAPV4HEADER *VirtualScreenInfo;
|
||||||
|
@ -300,7 +300,7 @@ WinNtWndGetKey (
|
|||||||
|
|
||||||
Routine Description:
|
Routine Description:
|
||||||
Reads the next keystroke from the input device. The WaitForKey Event can
|
Reads the next keystroke from the input device. The WaitForKey Event can
|
||||||
be used to test for existance of a keystroke via WaitForEvent () call.
|
be used to test for existence of a keystroke via WaitForEvent () call.
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
Private - The private structure of WinNt Gop device.
|
Private - The private structure of WinNt Gop device.
|
||||||
@ -309,7 +309,7 @@ WinNtWndGetKey (
|
|||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
EFI_SUCCESS - The keystroke information was returned.
|
EFI_SUCCESS - The keystroke information was returned.
|
||||||
EFI_NOT_READY - There was no keystroke data availiable.
|
EFI_NOT_READY - There was no keystroke data available.
|
||||||
EFI_DEVICE_ERROR - The keystroke information was not returned due to
|
EFI_DEVICE_ERROR - The keystroke information was not returned due to
|
||||||
hardware errors.
|
hardware errors.
|
||||||
EFI_INVALID_PARAMETER - KeyData is NULL.
|
EFI_INVALID_PARAMETER - KeyData is NULL.
|
||||||
|
@ -297,7 +297,7 @@ WinNtWndSize (
|
|||||||
@param X X location on graphics screen.
|
@param X X location on graphics screen.
|
||||||
@param Y Y location on the graphics screen.
|
@param Y Y location on the graphics screen.
|
||||||
@param Width Width of BltBuffer.
|
@param Width Width of BltBuffer.
|
||||||
@param Height Hight of BltBuffer
|
@param Height Height of BltBuffer
|
||||||
@param BltOperation Operation to perform on BltBuffer and video memory
|
@param BltOperation Operation to perform on BltBuffer and video memory
|
||||||
@param BltBuffer Buffer containing data to blt into video buffer.
|
@param BltBuffer Buffer containing data to blt into video buffer.
|
||||||
This buffer has a size of
|
This buffer has a size of
|
||||||
@ -311,7 +311,7 @@ WinNtWndSize (
|
|||||||
|
|
||||||
@retval EFI_SUCCESS The palette is updated with PaletteArray.
|
@retval EFI_SUCCESS The palette is updated with PaletteArray.
|
||||||
@retval EFI_INVALID_PARAMETER BltOperation is not valid.
|
@retval EFI_INVALID_PARAMETER BltOperation is not valid.
|
||||||
@retval EFI_DEVICE_ERROR A hardware error occured writting to the video
|
@retval EFI_DEVICE_ERROR A hardware error occurred writing to the video
|
||||||
buffer.
|
buffer.
|
||||||
|
|
||||||
**/
|
**/
|
||||||
@ -593,11 +593,11 @@ WinNtGopThreadWindowProc (
|
|||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
This thread simulates the end of WinMain () aplication. Each Winow nededs
|
This thread simulates the end of WinMain () application. Each Window needs
|
||||||
to process it's events. The messages are dispatched to
|
to process its events. The messages are dispatched to
|
||||||
WinNtGopThreadWindowProc ().
|
WinNtGopThreadWindowProc ().
|
||||||
Be very careful sine WinNtGopThreadWinMain () and WinNtGopThreadWindowProc ()
|
Be very careful since WinNtGopThreadWinMain () and WinNtGopThreadWindowProc ()
|
||||||
are running in a seperate thread. We have to do this to process the events.
|
are running in a separate thread. We have to do this to process the events.
|
||||||
|
|
||||||
@param lpParameter Handle of window to manage.
|
@param lpParameter Handle of window to manage.
|
||||||
|
|
||||||
@ -679,7 +679,7 @@ WinNtGopThreadWinMain (
|
|||||||
);
|
);
|
||||||
|
|
||||||
//
|
//
|
||||||
// The reset of this thread is the standard winows program. We need a sperate
|
// The reset of this thread is the standard windows program. We need a separate
|
||||||
// thread since we must process the message loop to make windows act like
|
// thread since we must process the message loop to make windows act like
|
||||||
// windows.
|
// windows.
|
||||||
//
|
//
|
||||||
|
@ -48,7 +48,7 @@ UINTN gFdInfoCount = 0;
|
|||||||
NT_FD_INFO *gFdInfo;
|
NT_FD_INFO *gFdInfo;
|
||||||
|
|
||||||
//
|
//
|
||||||
// Array that supports seperate memory rantes.
|
// Array that supports separate memory ranges.
|
||||||
// The memory ranges are set by PcdWinNtMemorySizeForSecMain.
|
// The memory ranges are set by PcdWinNtMemorySizeForSecMain.
|
||||||
// The number of array elements is allocated base on parsing
|
// The number of array elements is allocated base on parsing
|
||||||
// PcdWinNtMemorySizeForSecMain value and the memory is never freed.
|
// PcdWinNtMemorySizeForSecMain value and the memory is never freed.
|
||||||
@ -105,7 +105,7 @@ WinPeiAutoScan (
|
|||||||
|
|
||||||
Routine Description:
|
Routine Description:
|
||||||
Return the FD Size and base address. Since the FD is loaded from a
|
Return the FD Size and base address. Since the FD is loaded from a
|
||||||
file into host memory only the SEC will know it's address.
|
file into host memory only the SEC will know its address.
|
||||||
|
|
||||||
Arguments:
|
Arguments:
|
||||||
Index - Which FD, starts at zero.
|
Index - Which FD, starts at zero.
|
||||||
@ -273,7 +273,7 @@ Arguments:
|
|||||||
Returns:
|
Returns:
|
||||||
EFI_SUCCESS - The file was opened and mapped.
|
EFI_SUCCESS - The file was opened and mapped.
|
||||||
EFI_NOT_FOUND - FileName was not found in the current directory
|
EFI_NOT_FOUND - FileName was not found in the current directory
|
||||||
EFI_DEVICE_ERROR - An error occured attempting to map the opened file
|
EFI_DEVICE_ERROR - An error occurred attempting to map the opened file
|
||||||
|
|
||||||
--*/
|
--*/
|
||||||
{
|
{
|
||||||
@ -625,7 +625,7 @@ Arguments:
|
|||||||
SecCorePe32File - SEC Core PE32
|
SecCorePe32File - SEC Core PE32
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Success means control is transfered and thus we should never return
|
Success means control is transferred and thus we should never return
|
||||||
|
|
||||||
--*/
|
--*/
|
||||||
{
|
{
|
||||||
@ -993,7 +993,7 @@ PeCoffLoaderRelocateImageExtraAction (
|
|||||||
// the *.dll file as a library using Windows* APIs. This allows
|
// the *.dll file as a library using Windows* APIs. This allows
|
||||||
// source level debug. The image is still loaded and relocated
|
// source level debug. The image is still loaded and relocated
|
||||||
// in the Framework memory space like on a real system (by the code above),
|
// in the Framework memory space like on a real system (by the code above),
|
||||||
// but the entry point points into the DLL loaded by the code bellow.
|
// but the entry point points into the DLL loaded by the code below.
|
||||||
//
|
//
|
||||||
|
|
||||||
DllEntryPoint = NULL;
|
DllEntryPoint = NULL;
|
||||||
|
@ -82,7 +82,7 @@ Arguments:
|
|||||||
SecCorePe32File - SEC Core PE32
|
SecCorePe32File - SEC Core PE32
|
||||||
|
|
||||||
Returns:
|
Returns:
|
||||||
Success means control is transfered and thus we should never return
|
Success means control is transferred and thus we should never return
|
||||||
|
|
||||||
--*/
|
--*/
|
||||||
;
|
;
|
||||||
|
Reference in New Issue
Block a user