[Bf-blender-cvs] [b4a6418e2bd] blender-v2.83-release: Cleanup: add doxy sections for event queue handling

[Campbell Barton]

Commit: b4a6418e2bd3c350fdd87b29b9862e2e5b9b0e28
Author: Campbell Barton
Date:   Thu May 21 12:15:32 2020 +1000
Branches: blender-v2.83-release
https://developer.blender.org/rBb4a6418e2bd3c350fdd87b29b9862e2e5b9b0e28

Cleanup: add doxy sections for event queue handling

The main function to handle events didn't have it's own section.

===================================================================

M	source/blender/windowmanager/intern/wm_event_system.c

===================================================================

diff --git a/source/blender/windowmanager/intern/wm_event_system.c b/source/blender/windowmanager/intern/wm_event_system.c
index 136c24f8056..32b6b8b9c4a 100644
--- a/source/blender/windowmanager/intern/wm_event_system.c
+++ b/source/blender/windowmanager/intern/wm_event_system.c
@@ -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)