fix doxygen comments on keycodes

1 files changed, 79 insertions, 159 deletions

diff --git a/src/crepe/api/KeyCodes.h b/src/crepe/api/KeyCodes.h
index 16c2108..9e173e0 100644
--- a/src/crepe/api/KeyCodes.h
+++ b/src/crepe/api/KeyCodes.h
@@ -2,166 +2,88 @@
 
 //! Enumeration for mouse button inputs, including standard and extended buttons.
 enum class MouseButton {
-	//! No mouse button input.
-	NONE = 0,
-	//! Left mouse button.
-	LEFT_MOUSE = 1,
-	//! Right mouse button.
-	RIGHT_MOUSE = 2,
-	//! Middle mouse button (scroll wheel press).
-	MIDDLE_MOUSE = 3,
-	//! First extended mouse button.
-	X1_MOUSE = 4,
-	//! Second extended mouse button.
-	X2_MOUSE = 5,
-	//! Scroll wheel upward movement.
-	SCROLL_UP = 6,
-	//! Scroll wheel downward movement.
-	SCROLL_DOWN = 7,
+	NONE = 0, //!< No mouse button input.
+	LEFT_MOUSE = 1, //!< Left mouse button.
+	RIGHT_MOUSE = 2, //!< Right mouse button.
+	MIDDLE_MOUSE = 3, //!< Middle mouse button (scroll wheel press).
+	X1_MOUSE = 4, //!< First extended mouse button.
+	X2_MOUSE = 5, //!< Second extended mouse button.
+	SCROLL_UP = 6, //!< Scroll wheel upward movement.
+	SCROLL_DOWN = 7, //!< Scroll wheel downward movement.
 };
 
 //! Enumeration for keyboard key inputs, including printable characters, function keys, and keypad keys.
 enum class Keycode {
-	//! No key input.
-	NONE = 0,
-	//! Spacebar.
-	SPACE = 32,
-	//! Apostrophe (').
-	APOSTROPHE = 39,
-	//! Comma (,).
-	COMMA = 44,
-	//! Minus (-).
-	MINUS = 45,
-	//! Period (.).
-	PERIOD = 46,
-	//! Slash (/).
-	SLASH = 47,
-	//! Digit 0.
-	D0 = 48,
-	//! Digit 1.
-	D1 = 49,
-	//! Digit 2.
-	D2 = 50,
-	//! Digit 3.
-	D3 = 51,
-	//! Digit 4.
-	D4 = 52,
-	//! Digit 5.
-	D5 = 53,
-	//! Digit 6.
-	D6 = 54,
-	//! Digit 7.
-	D7 = 55,
-	//! Digit 8.
-	D8 = 56,
-	//! Digit 9.
-	D9 = 57,
-	//! Semicolon (;).
-	SEMICOLON = 59,
-	//! Equal sign (=).
-	EQUAL = 61,
-	//! Key 'A'.
-	A = 65,
-	//! Key 'B'.
-	B = 66,
-	//! Key 'C'.
-	C = 67,
-	//! Key 'D'.
-	D = 68,
-	//! Key 'E'.
-	E = 69,
-	//! Key 'F'.
-	F = 70,
-	//! Key 'G'.
-	G = 71,
-	//! Key 'H'.
-	H = 72,
-	//! Key 'I'.
-	I = 73,
-	//! Key 'J'.
-	J = 74,
-	//! Key 'K'.
-	K = 75,
-	//! Key 'L'.
-	L = 76,
-	//! Key 'M'.
-	M = 77,
-	//! Key 'N'.
-	N = 78,
-	//! Key 'O'.
-	O = 79,
-	//! Key 'P'.
-	P = 80,
-	//! Key 'Q'.
-	Q = 81,
-	//! Key 'R'.
-	R = 82,
-	//! Key 'S'.
-	S = 83,
-	//! Key 'T'.
-	T = 84,
-	//! Key 'U'.
-	U = 85,
-	//! Key 'V'.
-	V = 86,
-	//! Key 'W'.
-	W = 87,
-	//! Key 'X'.
-	X = 88,
-	//! Key 'Y'.
-	Y = 89,
-	//! Key 'Z'.
-	Z = 90,
-	//! Left bracket ([).
-	LEFT_BRACKET = 91,
-	//! Backslash (\).
-	BACKSLASH = 92,
-	//! Right bracket (]).
-	RIGHT_BRACKET = 93,
-	//! Grave accent (`).
-	GRAVE_ACCENT = 96,
-	//! Non-US key #1.
-	WORLD1 = 161,
-	//! Non-US key #2.
-	WORLD2 = 162,
-	//! Escape key.
-	ESCAPE = 256,
-	//! Enter key.
-	ENTER = 257,
-	//! Tab key.
-	TAB = 258,
-	//! Backspace key.
-	BACKSPACE = 259,
-	//! Insert key.
-	INSERT = 260,
-	//! Delete key.
-	DELETE = 261,
-	//! Right arrow key.
-	RIGHT = 262,
-	//! Left arrow key.
-	LEFT = 263,
-	//! Down arrow key.
-	DOWN = 264,
-	//! Up arrow key.
-	UP = 265,
-	//! Page Up key.
-	PAGE_UP = 266,
-	//! Page Down key.
-	PAGE_DOWN = 267,
-	//! Home key.
-	HOME = 268,
-	//! End key.
-	END = 269,
-	//! Caps Lock key.
-	CAPS_LOCK = 280,
-	//! Scroll Lock key.
-	SCROLL_LOCK = 281,
-	//! Num Lock key.
-	NUM_LOCK = 282,
-	//! Print Screen key.
-	PRINT_SCREEN = 283,
-	//! Pause key.
-	PAUSE = 284,
+	NONE = 0, //!< No key input.
+	SPACE = 32, //!< Spacebar.
+	APOSTROPHE = 39, //!< Apostrophe (').
+	COMMA = 44, //!< Comma (,).
+	MINUS = 45, //!< Minus (-).
+	PERIOD = 46, //!< Period (.).
+	SLASH = 47, //!< Slash (/).
+	D0 = 48, //!< Digit 0.
+	D1 = 49, //!< Digit 1.
+	D2 = 50, //!< Digit 2.
+	D3 = 51, //!< Digit 3.
+	D4 = 52, //!< Digit 4.
+	D5 = 53, //!< Digit 5.
+	D6 = 54, //!< Digit 6.
+	D7 = 55, //!< Digit 7.
+	D8 = 56, //!< Digit 8.
+	D9 = 57, //!< Digit 9.
+	SEMICOLON = 59, //!< Semicolon (;).
+	EQUAL = 61, //!< Equal sign (=).
+	A = 65, //!< Key 'A'.
+	B = 66, //!< Key 'B'.
+	C = 67, //!< Key 'C'.
+	D = 68, //!< Key 'D'.
+	E = 69, //!< Key 'E'.
+	F = 70, //!< Key 'F'.
+	G = 71, //!< Key 'G'.
+	H = 72, //!< Key 'H'.
+	I = 73, //!< Key 'I'.
+	J = 74, //!< Key 'J'.
+	K = 75, //!< Key 'K'.
+	L = 76, //!< Key 'L'.
+	M = 77, //!< Key 'M'.
+	N = 78, //!< Key 'N'.
+	O = 79, //!< Key 'O'.
+	P = 80, //!< Key 'P'.
+	Q = 81, //!< Key 'Q'.
+	R = 82, //!< Key 'R'.
+	S = 83, //!< Key 'S'.
+	T = 84, //!< Key 'T'.
+	U = 85, //!< Key 'U'.
+	V = 86, //!< Key 'V'.
+	W = 87, //!< Key 'W'.
+	X = 88, //!< Key 'X'.
+	Y = 89, //!< Key 'Y'.
+	Z = 90, //!< Key 'Z'.
+	LEFT_BRACKET = 91, //!< Left bracket ([).
+	BACKSLASH = 92, //!< Backslash (\).
+	RIGHT_BRACKET = 93, //!< Right bracket (]).
+	GRAVE_ACCENT = 96, //!< Grave accent (`).
+	WORLD1 = 161, //!< Non-US key #1.
+	WORLD2 = 162, //!< Non-US key #2.
+	ESCAPE = 256, //!< Escape key.
+	ENTER = 257, //!< Enter key.
+	TAB = 258, //!< Tab key.
+	BACKSPACE = 259, //!< Backspace key.
+	INSERT = 260, //!< Insert key.
+	DELETE = 261, //!< Delete key.
+	RIGHT = 262, //!< Right arrow key.
+	LEFT = 263, //!< Left arrow key.
+	DOWN = 264, //!< Down arrow key.
+	UP = 265, //!< Up arrow key.
+	PAGE_UP = 266, //!< Page Up key.
+	PAGE_DOWN = 267, //!< Page Down key.
+	HOME = 268, //!< Home key.
+	END = 269, //!< End key.
+	CAPS_LOCK = 280, //!< Caps Lock key.
+	SCROLL_LOCK = 281, //!< Scroll Lock key.
+	NUM_LOCK = 282, //!< Num Lock key.
+	PRINT_SCREEN = 283, //!< Print Screen key.
+	PAUSE = 284, //!< Pause key.
 	/**
 	 * \name Function keys (F1-F25).
 	 * \{
@@ -218,7 +140,6 @@ enum class Keycode {
 	 * \name Modifier keys.
 	 * \{
 	 */
-	//! Modifier keys.
 	LEFT_SHIFT = 340,
 	LEFT_CONTROL = 341,
 	LEFT_ALT = 342,
@@ -228,6 +149,5 @@ enum class Keycode {
 	RIGHT_ALT = 346,
 	RIGHT_SUPER = 347,
 	/// \}
-	//! Menu key.
-	MENU = 348,
+	MENU = 348, //!< Menu key.
 };