changeset 530:acc483db7bff

core: doxygenize mouse
author David Demelier <markand@malikania.fr>
date Sat, 04 Mar 2023 20:21:37 +0100
parents 7e835d43ef74
children 593703440a05
files libmlk-core/mlk/core/mouse.h
diffstat 1 files changed, 26 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/libmlk-core/mlk/core/mouse.h	Sat Mar 04 20:18:17 2023 +0100
+++ b/libmlk-core/mlk/core/mouse.h	Sat Mar 04 20:21:37 2023 +0100
@@ -19,10 +19,36 @@
 #ifndef MLK_CORE_MOUSE_H
 #define MLK_CORE_MOUSE_H
 
+/**
+ * \file mouse.h
+ * \brief Mouse definitions
+ */
+
+/**
+ * \enum mlk_mouse_button
+ * \brief Mouse button
+ *
+ * This enumeration is implemented as a bitmask.
+ */
 enum mlk_mouse_button {
+	/**
+	 * No button pressed.
+	 */
 	MLK_MOUSE_BUTTON_NONE   = 0,
+
+	/**
+	 * Left button.
+	 */
 	MLK_MOUSE_BUTTON_LEFT   = (1 << 0),
+
+	/**
+	 * Middle click button.
+	 */
 	MLK_MOUSE_BUTTON_MIDDLE = (1 << 1),
+
+	/**
+	 * Right button.
+	 */
 	MLK_MOUSE_BUTTON_RIGHT  = (1 << 2)
 };