diff options
| author | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-04 08:04:10 +0000 |
|---|---|---|
| committer | qwang12 <qwang12@6f19259b-4bc3-4df7-8a09-765794883524> | 2008-07-04 08:04:10 +0000 |
| commit | b30312ba2985176709dbcd0aaab9804668720eed (patch) | |
| tree | e2e300e115599be87f99578432846f28e572ab2b /MdeModulePkg/Universal/BdsDxe/Hotkey.h | |
| parent | 9359e53fcbdf72809f34d5141b642db91e6c9a18 (diff) | |
| download | edk2-b30312ba2985176709dbcd0aaab9804668720eed.zip edk2-b30312ba2985176709dbcd0aaab9804668720eed.tar.gz edk2-b30312ba2985176709dbcd0aaab9804668720eed.tar.bz2 | |
Update the function headers to Doxygen format.
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@5410 6f19259b-4bc3-4df7-8a09-765794883524
Diffstat (limited to 'MdeModulePkg/Universal/BdsDxe/Hotkey.h')
| -rw-r--r-- | MdeModulePkg/Universal/BdsDxe/Hotkey.h | 65 |
1 files changed, 25 insertions, 40 deletions
diff --git a/MdeModulePkg/Universal/BdsDxe/Hotkey.h b/MdeModulePkg/Universal/BdsDxe/Hotkey.h index c34026b..88966d0 100644 --- a/MdeModulePkg/Universal/BdsDxe/Hotkey.h +++ b/MdeModulePkg/Universal/BdsDxe/Hotkey.h @@ -37,72 +37,57 @@ typedef struct { #define VarKeyOrder L"KeyOrder"
+/**
+
+ Create Key#### for the given hotkey.
+
+
+ @param KeyOption - The Hot Key Option to be added.
+ @param KeyOptionNumber - The key option number for Key#### (optional).
+
+ @retval EFI_SUCCESS Register hotkey successfully.
+ @retval EFI_INVALID_PARAMETER The hotkey option is invalid.
+
+**/
EFI_STATUS
RegisterHotkey (
IN EFI_KEY_OPTION *KeyOption,
OUT UINT16 *KeyOptionNumber
)
-/*++
-
-Routine Description:
+;
- Create Key#### for the given hotkey.
+/**
-Arguments:
+ Delete Key#### for the given Key Option number.
- KeyOption - The Hot Key Option to be added.
- KeyOptionNumber - The key option number for Key#### (optional).
-Returns:
+ @param KeyOptionNumber - Key option number for Key####
- EFI_SUCCESS - Register hotkey successfully.
- EFI_INVALID_PARAMETER - The hotkey option is invalid.
-
---*/
-;
+ @retval EFI_SUCCESS Unregister hotkey successfully.
+ @retval EFI_NOT_FOUND No Key#### is found for the given Key Option number.
+**/
EFI_STATUS
UnregisterHotkey (
IN UINT16 KeyOptionNumber
)
-/*++
-
-Routine Description:
+;
- Delete Key#### for the given Key Option number.
-Arguments:
+/**
- KeyOptionNumber - Key option number for Key####
+ Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.
-Returns:
- EFI_SUCCESS - Unregister hotkey successfully.
- EFI_NOT_FOUND - No Key#### is found for the given Key Option number.
-
---*/
-;
+ @param VOID
+ @retval EFI_SUCCESS Hotkey services successfully initialized.
+**/
EFI_STATUS
InitializeHotkeyService (
VOID
)
-/*++
-
-Routine Description:
-
- Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.
-
-Arguments:
-
- None
-
-Returns:
-
- EFI_SUCCESS - Hotkey services successfully initialized.
-
---*/
;
#endif
|