diff options
| author | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-09 14:04:41 +0000 |
|---|---|---|
| committer | lgao4 <lgao4@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-12-09 14:04:41 +0000 |
| commit | 992f22b99a90d1b217b1e6f702b238f1ff319753 (patch) | |
| tree | 50fb6f472776aef941ad8a2661d9d776a9b6145c /MdePkg/Include/Protocol/SimpleTextInEx.h | |
| parent | d0a915a5ad4efb7e2d0d7a29fc157bdf1b475d80 (diff) | |
| download | edk2-platforms-992f22b99a90d1b217b1e6f702b238f1ff319753.tar.xz | |
Add the detailed descriptions for the structure data member in these protocol.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6935 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdePkg/Include/Protocol/SimpleTextInEx.h')
| -rw-r--r-- | MdePkg/Include/Protocol/SimpleTextInEx.h | 56 |
1 files changed, 26 insertions, 30 deletions
diff --git a/MdePkg/Include/Protocol/SimpleTextInEx.h b/MdePkg/Include/Protocol/SimpleTextInEx.h index 8dcb5e1419..95c5995ce8 100644 --- a/MdePkg/Include/Protocol/SimpleTextInEx.h +++ b/MdePkg/Include/Protocol/SimpleTextInEx.h @@ -60,42 +60,38 @@ EFI_STATUS );
-//
-// EFI_KEY_TOGGLE_STATE
-//
+///
+/// EFI_KEY_TOGGLE_STATE. The toggle state are defined.
+/// They are EFI_TOGGLE_STATE_VALID, EFI_SCROLL_LOCK_ACTIVE
+/// EFI_NUM_LOCK_ACTIVE, EFI_CAPS_LOCK_ACTIVE
+///
typedef UINT8 EFI_KEY_TOGGLE_STATE;
-/**
- Definition of EFI_KEY_STATE
-
- @param KeyShiftState Reflects the currently pressed shift
- modifiers for the input device. The
- returned value is valid only if the high
- order bit has been set.
-
- @param KeyToggleState Reflects the current internal state of
- various toggled attributes. The returned
- value is valid only if the high order
- bit has been set.
-
-**/
typedef struct _EFI_KEY_STATE {
+ ///
+ /// Reflects the currently pressed shift
+ /// modifiers for the input device. The
+ /// returned value is valid only if the high
+ /// order bit has been set.
+ ///
UINT32 KeyShiftState;
+ ///
+ /// Reflects the current internal state of
+ /// various toggled attributes. The returned
+ /// value is valid only if the high order
+ /// bit has been set.
+ ///
EFI_KEY_TOGGLE_STATE KeyToggleState;
} EFI_KEY_STATE;
-/**
- Definition of EFI_KEY_DATA.
-
- @param Key The EFI scan code and Unicode value returned from
- the input device.
-
- @param KeyState The current state of various toggled
- attributes as well as input modifier values.
-
-**/
typedef struct {
+ ///
+ /// The EFI scan code and Unicode value returned from the input device.
+ ///
EFI_INPUT_KEY Key;
+ ///
+ /// The current state of various toggled attributes as well as input modifier values.
+ ///
EFI_KEY_STATE KeyState;
} EFI_KEY_DATA;
@@ -234,9 +230,9 @@ EFI_STATUS IN EFI_KEY_TOGGLE_STATE *KeyToggleState
);
-//
-// EFI_KEY_NOTIFY
-//
+///
+/// The function will be called when the key sequence is typed specified by KeyData.
+///
typedef
EFI_STATUS
(EFIAPI *EFI_KEY_NOTIFY_FUNCTION)(
|