Cleanup: add doxy sections for event queue handling
authorCampbell Barton <ideasman42@gmail.com>
Thu, 21 May 2020 02:15:32 +0000 (12:15 +1000)
committerCampbell Barton <ideasman42@gmail.com>
Thu, 21 May 2020 02:22:32 +0000 (12:22 +1000)
The main function to handle events didn't have it's own section.

source/blender/windowmanager/intern/wm_event_system.c

index 136c24f8056f37ab33a1f81993f7d250892c985f..32b6b8b9c4a59e34b05b887fab5fec4e15228561 100644 (file)
@@ -2669,6 +2669,12 @@ static int wm_handlers_do_gizmo_handler(bContext *C,
   return action;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Handle Single Event (All Handler Types)
+ * \{ */
+
 static int wm_handlers_do_intern(bContext *C, wmEvent *event, ListBase *handlers)
 {
   const bool do_debug_handler =
@@ -2970,6 +2976,14 @@ static int wm_handlers_do(bContext *C, wmEvent *event, ListBase *handlers)
   return action;
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Event Queue Utilities
+ *
+ * Utilities used by #wm_event_do_handlers.
+ * \{ */
+
 static bool wm_event_inside_rect(const wmEvent *event, const rcti *rect)
 {
   if (wm_event_always_pass(event)) {
@@ -3134,6 +3148,14 @@ static void wm_event_free_and_remove_from_queue_if_valid(wmEvent *event)
   }
 }
 
+/** \} */
+
+/* -------------------------------------------------------------------- */
+/** \name Main Event Queue (Every Window)
+ *
+ * Handle events for all windows, run from the #WM_main event loop.
+ * \{ */
+
 /* called in main loop */
 /* goes over entire hierarchy:  events -> window -> screen -> area -> region */
 void wm_event_do_handlers(bContext *C)