summaryrefslogtreecommitdiffstats
path: root/MdePkg
diff options
context:
space:
mode:
authorvanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-24 00:11:16 +0000
committervanjeff <vanjeff@6f19259b-4bc3-4df7-8a09-765794883524>2008-12-24 00:11:16 +0000
commitbcb85cda9ddec5fec9efd4ea2d38e466ed6c0dad (patch)
tree5d71609382cb3741153db92bcf9f85acb96db931 /MdePkg
parent48557c6550adecf39e1e8e140b1736275d070dfb (diff)
downloadedk2-bcb85cda9ddec5fec9efd4ea2d38e466ed6c0dad.tar.gz
edk2-bcb85cda9ddec5fec9efd4ea2d38e466ed6c0dad.tar.bz2
edk2-bcb85cda9ddec5fec9efd4ea2d38e466ed6c0dad.zip
updated some comments.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@7106 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg')
-rw-r--r--MdePkg/Include/Protocol/GraphicsOutput.h20
-rw-r--r--MdePkg/Include/Protocol/UgaDraw.h2
2 files changed, 12 insertions, 10 deletions
diff --git a/MdePkg/Include/Protocol/GraphicsOutput.h b/MdePkg/Include/Protocol/GraphicsOutput.h
index 7782f5d7c3..8d63f9787e 100644
--- a/MdePkg/Include/Protocol/GraphicsOutput.h
+++ b/MdePkg/Include/Protocol/GraphicsOutput.h
@@ -93,12 +93,13 @@ typedef struct {
} EFI_GRAPHICS_OUTPUT_MODE_INFORMATION;
/**
- Return the current video mode information.
+ Returns information for an available graphics mode that the graphics device
+ and the set of active video output devices supports.
- @param This Protocol instance pointer.
- @param ModeNumber The mode number to return information on.
- @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
- @param Info A pointer to callee allocated buffer that returns information about ModeNumber.
+ @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
+ @param ModeNumber The mode number to return information on.
+ @param SizeOfInfo A pointer to the size, in bytes, of the Info buffer.
+ @param Info A pointer to callee allocated buffer that returns information about ModeNumber.
@retval EFI_SUCCESS Mode information returned.
@retval EFI_BUFFER_TOO_SMALL The Info buffer was too small.
@@ -117,12 +118,13 @@ EFI_STATUS
);
/**
- Return the current video mode information.
+ Set the video device into the specified mode and clears the visible portions of
+ the output display to black.
- @param This Protocol instance pointer.
- @param ModeNumber The mode number to be set.
+ @param This The EFI_GRAPHICS_OUTPUT_PROTOCOL instance.
+ @param ModeNumber Abstraction that defines the current video mode.
- @retval EFI_SUCCESS Graphics mode was changed.
+ @retval EFI_SUCCESS The graphics mode specified by ModeNumber was selected.
@retval EFI_DEVICE_ERROR The device had an error and could not complete the request.
@retval EFI_UNSUPPORTED ModeNumber is not supported by this device.
diff --git a/MdePkg/Include/Protocol/UgaDraw.h b/MdePkg/Include/Protocol/UgaDraw.h
index 5dd8fe8292..1dc2a956c1 100644
--- a/MdePkg/Include/Protocol/UgaDraw.h
+++ b/MdePkg/Include/Protocol/UgaDraw.h
@@ -135,7 +135,7 @@ typedef enum {
@retval EFI_INVALID_PARAMETER - BltOperation is not valid.
@retval EFI_DEVICE_ERROR - A hardware error occured writting to the video buffer.
---*/
+**/
typedef
EFI_STATUS
(EFIAPI *EFI_UGA_DRAW_PROTOCOL_BLT)(