\r
**/\r
\r
-#ifndef _HOTKEY_H\r
-#define _HOTKEY_H\r
+#ifndef _HOTKEY_H_\r
+#define _HOTKEY_H_\r
\r
#include "Bds.h"\r
#include "String.h"\r
\r
#define BDS_HOTKEY_OPTION_FROM_LINK(a) CR (a, BDS_HOTKEY_OPTION, Link, BDS_HOTKEY_OPTION_SIGNATURE)\r
\r
-#define VarKeyOrder L"KeyOrder"\r
+#define VAR_KEY_ORDER L"KeyOrder"\r
\r
+/**\r
+\r
+ Create Key#### for the given hotkey.\r
+\r
+\r
+ @param KeyOption - The Hot Key Option to be added.\r
+ @param KeyOptionNumber - The key option number for Key#### (optional).\r
+\r
+ @retval EFI_SUCCESS Register hotkey successfully.\r
+ @retval EFI_INVALID_PARAMETER The hotkey option is invalid.\r
+\r
+**/\r
EFI_STATUS\r
RegisterHotkey (\r
IN EFI_KEY_OPTION *KeyOption,\r
OUT UINT16 *KeyOptionNumber\r
-)\r
-/*++\r
+ );\r
\r
-Routine Description:\r
+/**\r
\r
- Create Key#### for the given hotkey.\r
-\r
-Arguments:\r
-\r
- KeyOption - The Hot Key Option to be added.\r
- KeyOptionNumber - The key option number for Key#### (optional).\r
+ Delete Key#### for the given Key Option number.\r
\r
-Returns:\r
\r
- EFI_SUCCESS - Register hotkey successfully.\r
- EFI_INVALID_PARAMETER - The hotkey option is invalid.\r
+ @param KeyOptionNumber - Key option number for Key####\r
\r
---*/\r
-;\r
+ @retval EFI_SUCCESS Unregister hotkey successfully.\r
+ @retval EFI_NOT_FOUND No Key#### is found for the given Key Option number.\r
\r
+**/\r
EFI_STATUS\r
UnregisterHotkey (\r
IN UINT16 KeyOptionNumber\r
-)\r
-/*++\r
+ );\r
\r
-Routine Description:\r
\r
- Delete Key#### for the given Key Option number.\r
+/**\r
\r
-Arguments:\r
-\r
- KeyOptionNumber - Key option number for Key####\r
-\r
-Returns:\r
+ Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.\r
\r
- EFI_SUCCESS - Unregister hotkey successfully.\r
- EFI_NOT_FOUND - No Key#### is found for the given Key Option number.\r
\r
---*/\r
-;\r
+ @param VOID\r
\r
+ @retval EFI_SUCCESS Hotkey services successfully initialized.\r
\r
+**/\r
EFI_STATUS\r
InitializeHotkeyService (\r
VOID\r
- )\r
-/*++\r
-\r
-Routine Description:\r
-\r
- Process all the "Key####" variables, associate Hotkeys with corresponding Boot Options.\r
-\r
-Arguments:\r
-\r
- None\r
-\r
-Returns:\r
-\r
- EFI_SUCCESS - Hotkey services successfully initialized.\r
-\r
---*/\r
-;\r
+ );\r
\r
#endif\r