From 7e927174396443cdc4c5544dad13faca7299d183 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Wed, 8 Dec 2021 17:12:41 +1100
Subject: Cleanup: move public doc-strings into headers for 'windowmanager'

Ref T92709
---
 source/blender/windowmanager/wm.h | 53 ++++++++++++++++++++++++++++++++++++++-
 1 file changed, 52 insertions(+), 1 deletion(-)

(limited to 'source/blender/windowmanager/wm.h')

diff --git a/source/blender/windowmanager/wm.h b/source/blender/windowmanager/wm.h
index cfef70b7dcc..e67b1581875 100644
--- a/source/blender/windowmanager/wm.h
+++ b/source/blender/windowmanager/wm.h
@@ -43,49 +43,98 @@ typedef struct wmPaintCursor {
   short region_type;
 } wmPaintCursor;
 
+/**
+ * Cause a delayed #WM_exit()
+ * call to avoid leaking memory when trying to exit from within operators.
+ */
 void wm_exit_schedule_delayed(const bContext *C);
 
+/**
+ * Context is allowed to be NULL, do not free wm itself (lib_id.c).
+ */
 extern void wm_close_and_free(bContext *C, wmWindowManager *);
 extern void wm_close_and_free_all(bContext *C, ListBase *);
 
+/**
+ * On startup, it adds all data, for matching.
+ */
 extern void wm_add_default(struct Main *bmain, bContext *C);
 extern void wm_clear_default_size(bContext *C);
 
 /* register to windowmanager for redo or macro */
+
+/**
+ * Called on event handling by `event_system.c`.
+ *
+ * All operations get registered in the windowmanager here.
+ */
 void wm_operator_register(bContext *C, wmOperator *op);
 
 /* wm_operator.c, for init/exit */
+
 void wm_operatortype_free(void);
+/**
+ * Called on initialize #WM_init().
+ */
 void wm_operatortype_init(void);
+/**
+ * Default key-map for windows and screens, only call once per WM.
+ */
 void wm_window_keymap(wmKeyConfig *keyconf);
 void wm_operatortypes_register(void);
 
 /* wm_gesture.c */
+/* called in wm_draw.c */
+
 void wm_gesture_draw(struct wmWindow *win);
+/**
+ * Tweak and line gestures.
+ */
 int wm_gesture_evaluate(wmGesture *gesture, const struct wmEvent *event);
 void wm_gesture_tag_redraw(struct wmWindow *win);
 
 /* wm_gesture_ops.c */
+
+/**
+ * Standard tweak, called after window handlers passed on event.
+ */
 void wm_tweakevent_test(bContext *C, const wmEvent *event, int action);
 
 /* wm_jobs.c */
+
+/**
+ * Hard-coded to event #TIMERJOBS.
+ */
 void wm_jobs_timer(wmWindowManager *wm, wmTimer *wt);
+/**
+ * Kill job entirely, also removes timer itself.
+ */
 void wm_jobs_timer_end(wmWindowManager *wm, wmTimer *wt);
 
 /* wm_files.c */
+
+/**
+ * Run the auto-save timer action.
+ */
 void wm_autosave_timer(struct Main *bmain, wmWindowManager *wm, wmTimer *wt);
 void wm_autosave_timer_begin(struct wmWindowManager *wm);
 void wm_autosave_timer_end(wmWindowManager *wm);
 void wm_autosave_delete(void);
 
 /* wm_splash_screen.c */
+
 void WM_OT_splash(wmOperatorType *ot);
 void WM_OT_splash_about(wmOperatorType *ot);
 
 /* wm_stereo.c */
+
 void wm_stereo3d_draw_sidebyside(wmWindow *win, int view);
 void wm_stereo3d_draw_topbottom(wmWindow *win, int view);
 
+/**
+ * If needed, adjust \a r_mouse_xy
+ * so that drawn cursor and handled mouse position are matching visually.
+ */
 void wm_stereo3d_mouse_offset_apply(wmWindow *win, int r_mouse_xy[2]);
 int wm_stereo3d_set_exec(bContext *C, wmOperator *op);
 int wm_stereo3d_set_invoke(bContext *C, wmOperator *op, const wmEvent *event);
@@ -93,7 +142,9 @@ void wm_stereo3d_set_draw(bContext *C, wmOperator *op);
 bool wm_stereo3d_set_check(bContext *C, wmOperator *op);
 void wm_stereo3d_set_cancel(bContext *C, wmOperator *op);
 
-/* init operator properties */
+/**
+ * Initialize operator properties.
+ */
 void wm_open_init_load_ui(wmOperator *op, bool use_prefs);
 void wm_open_init_use_scripts(wmOperator *op, bool use_prefs);
 
-- 
cgit v1.2.3