From 621bf47e91b21f4f08ba87023c6e69368c3cf9b7 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sun, 19 Jan 2014 23:14:24 +1100 Subject: Docs: doxygen file descriptions for BLF, GPU and WM --- source/blender/windowmanager/WM_api.h | 4 ++-- source/blender/windowmanager/intern/wm.c | 4 ++++ source/blender/windowmanager/intern/wm_cursors.c | 3 ++- source/blender/windowmanager/intern/wm_dragdrop.c | 3 ++- source/blender/windowmanager/intern/wm_draw.c | 3 ++- source/blender/windowmanager/intern/wm_event_system.c | 6 +++++- source/blender/windowmanager/intern/wm_files.c | 6 ++---- source/blender/windowmanager/intern/wm_gesture.c | 4 ++-- source/blender/windowmanager/intern/wm_init_exit.c | 2 ++ source/blender/windowmanager/intern/wm_jobs.c | 5 ++--- source/blender/windowmanager/intern/wm_keymap.c | 3 ++- source/blender/windowmanager/intern/wm_operators.c | 3 +++ source/blender/windowmanager/intern/wm_subwindow.c | 3 ++- source/blender/windowmanager/intern/wm_window.c | 4 +++- source/blender/windowmanager/wm_event_system.h | 2 +- 15 files changed, 36 insertions(+), 19 deletions(-) (limited to 'source/blender/windowmanager') diff --git a/source/blender/windowmanager/WM_api.h b/source/blender/windowmanager/WM_api.h index 046152d07a1..b635544add0 100644 --- a/source/blender/windowmanager/WM_api.h +++ b/source/blender/windowmanager/WM_api.h @@ -87,7 +87,7 @@ void WM_init_splash (struct bContext *C); void WM_check (struct bContext *C); -struct wmWindow *WM_window_open (struct bContext *C, struct rcti *rect); +struct wmWindow *WM_window_open (struct bContext *C, const struct rcti *rect); int WM_window_pixels_x (struct wmWindow *win); int WM_window_pixels_y (struct wmWindow *win); @@ -137,7 +137,7 @@ int WM_userdef_event_map(int kmitype); struct wmEventHandler *WM_event_add_keymap_handler(ListBase *handlers, wmKeyMap *keymap); /* boundbox, optional subwindow boundbox for offset */ -struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bb, rcti *swinbb); +struct wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bb, const rcti *swinbb); /* priority not implemented, it adds in begin */ struct wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMap *keymap, int priority); diff --git a/source/blender/windowmanager/intern/wm.c b/source/blender/windowmanager/intern/wm.c index 2fbf92ebed7..6a91eca2c7f 100644 --- a/source/blender/windowmanager/intern/wm.c +++ b/source/blender/windowmanager/intern/wm.c @@ -26,6 +26,10 @@ /** \file blender/windowmanager/intern/wm.c * \ingroup wm + * + * Internal functions for managing UI registrable types (operator, UI and menu types) + * + * Also Blenders main event loop (WM_main) */ #include diff --git a/source/blender/windowmanager/intern/wm_cursors.c b/source/blender/windowmanager/intern/wm_cursors.c index 09a83834610..01cd1514a3a 100644 --- a/source/blender/windowmanager/intern/wm_cursors.c +++ b/source/blender/windowmanager/intern/wm_cursors.c @@ -27,9 +27,10 @@ /** \file blender/windowmanager/intern/wm_cursors.c * \ingroup wm + * + * Cursor pixmap and cursor utility functions to change the cursor. */ - #include #include diff --git a/source/blender/windowmanager/intern/wm_dragdrop.c b/source/blender/windowmanager/intern/wm_dragdrop.c index 12e23c3d0c7..7675d4d4418 100644 --- a/source/blender/windowmanager/intern/wm_dragdrop.c +++ b/source/blender/windowmanager/intern/wm_dragdrop.c @@ -26,9 +26,10 @@ /** \file blender/windowmanager/intern/wm_dragdrop.c * \ingroup wm + * + * Our own drag-and-drop, drag state and drop boxes. */ - #include #include "DNA_windowmanager_types.h" diff --git a/source/blender/windowmanager/intern/wm_draw.c b/source/blender/windowmanager/intern/wm_draw.c index b4d29f05e15..e89980f53fc 100644 --- a/source/blender/windowmanager/intern/wm_draw.c +++ b/source/blender/windowmanager/intern/wm_draw.c @@ -26,9 +26,10 @@ /** \file blender/windowmanager/intern/wm_draw.c * \ingroup wm + * + * Handle OpenGL buffers for windowing, also paint cursor. */ - #include #include #include diff --git a/source/blender/windowmanager/intern/wm_event_system.c b/source/blender/windowmanager/intern/wm_event_system.c index f8488b63c85..308c14814af 100644 --- a/source/blender/windowmanager/intern/wm_event_system.c +++ b/source/blender/windowmanager/intern/wm_event_system.c @@ -26,6 +26,10 @@ /** \file blender/windowmanager/intern/wm_event_system.c * \ingroup wm + * + * Handle events and notifiers from GHOST input (mouse, keyboard, tablet, ndof). + * + * Also some operator reports utility functions. */ @@ -2457,7 +2461,7 @@ wmEventHandler *WM_event_add_keymap_handler_priority(ListBase *handlers, wmKeyMa return handler; } -wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, rcti *bblocal, rcti *bbwin) +wmEventHandler *WM_event_add_keymap_handler_bb(ListBase *handlers, wmKeyMap *keymap, const rcti *bblocal, const rcti *bbwin) { wmEventHandler *handler = WM_event_add_keymap_handler(handlers, keymap); diff --git a/source/blender/windowmanager/intern/wm_files.c b/source/blender/windowmanager/intern/wm_files.c index 9c479a2b868..55f0d922005 100644 --- a/source/blender/windowmanager/intern/wm_files.c +++ b/source/blender/windowmanager/intern/wm_files.c @@ -25,6 +25,8 @@ /** \file blender/windowmanager/intern/wm_files.c * \ingroup wm + * + * User level access for blend file read/write, file-history and userprefs. */ @@ -62,7 +64,6 @@ #include "BLF_translation.h" #include "DNA_anim_types.h" -#include "DNA_ipo_types.h" // XXX old animation system #include "DNA_object_types.h" #include "DNA_space_types.h" #include "DNA_userdef_types.h" @@ -1144,6 +1145,3 @@ void wm_autosave_read(bContext *C, ReportList *reports) WM_file_read(C, filename, reports); } - - - diff --git a/source/blender/windowmanager/intern/wm_gesture.c b/source/blender/windowmanager/intern/wm_gesture.c index 83cb6fd83d1..6e34c776719 100644 --- a/source/blender/windowmanager/intern/wm_gesture.c +++ b/source/blender/windowmanager/intern/wm_gesture.c @@ -26,9 +26,10 @@ /** \file blender/windowmanager/intern/wm_gesture.c * \ingroup wm + * + * Gestures (cursor motions) creating, evaluating and drawing, shared between operators. */ - #include "DNA_screen_types.h" #include "DNA_vec_types.h" #include "DNA_userdef_types.h" @@ -38,7 +39,6 @@ #include "BLI_blenlib.h" #include "BLI_math.h" -#include "BLI_scanfill.h" /* lasso tessellation */ #include "BLI_utildefines.h" #include "BLI_lasso.h" diff --git a/source/blender/windowmanager/intern/wm_init_exit.c b/source/blender/windowmanager/intern/wm_init_exit.c index 8b43a6af606..5196b584816 100644 --- a/source/blender/windowmanager/intern/wm_init_exit.c +++ b/source/blender/windowmanager/intern/wm_init_exit.c @@ -26,6 +26,8 @@ /** \file blender/windowmanager/intern/wm_init_exit.c * \ingroup wm + * + * Manage initializing resources and correctly shutting down. */ #include diff --git a/source/blender/windowmanager/intern/wm_jobs.c b/source/blender/windowmanager/intern/wm_jobs.c index 7da9a1c09d3..4cf5813d080 100644 --- a/source/blender/windowmanager/intern/wm_jobs.c +++ b/source/blender/windowmanager/intern/wm_jobs.c @@ -26,9 +26,10 @@ /** \file blender/windowmanager/intern/wm_jobs.c * \ingroup wm + * + * Threaded job manager (high level job access). */ - #include #include "DNA_windowmanager_types.h" @@ -56,8 +57,6 @@ #include "PIL_time.h" -/* ********************** Threaded Jobs Manager ****************************** */ - /* * Add new job * - register in WM diff --git a/source/blender/windowmanager/intern/wm_keymap.c b/source/blender/windowmanager/intern/wm_keymap.c index 4758ba5d775..36099d5de8e 100644 --- a/source/blender/windowmanager/intern/wm_keymap.c +++ b/source/blender/windowmanager/intern/wm_keymap.c @@ -26,9 +26,10 @@ /** \file blender/windowmanager/intern/wm_keymap.c * \ingroup wm + * + * Configurable key-maps - add/remove/find/compare/patch... */ - #include #include "DNA_object_types.h" diff --git a/source/blender/windowmanager/intern/wm_operators.c b/source/blender/windowmanager/intern/wm_operators.c index 38e9b6d7d33..255d6f19789 100644 --- a/source/blender/windowmanager/intern/wm_operators.c +++ b/source/blender/windowmanager/intern/wm_operators.c @@ -26,6 +26,9 @@ /** \file blender/windowmanager/intern/wm_operators.c * \ingroup wm + * + * Functions for dealing with wmOperator, adding, removing, calling + * as well as some generic operators and shared operator properties. */ diff --git a/source/blender/windowmanager/intern/wm_subwindow.c b/source/blender/windowmanager/intern/wm_subwindow.c index 75608a850ac..10a24338b35 100644 --- a/source/blender/windowmanager/intern/wm_subwindow.c +++ b/source/blender/windowmanager/intern/wm_subwindow.c @@ -30,9 +30,10 @@ /** \file blender/windowmanager/intern/wm_subwindow.c * \ingroup wm + * + * Internal subwindows used for OpenGL state, used for regions and screens. */ - #include #include "MEM_guardedalloc.h" diff --git a/source/blender/windowmanager/intern/wm_window.c b/source/blender/windowmanager/intern/wm_window.c index 1e682be603b..f2f9443c111 100644 --- a/source/blender/windowmanager/intern/wm_window.c +++ b/source/blender/windowmanager/intern/wm_window.c @@ -26,6 +26,8 @@ /** \file blender/windowmanager/intern/wm_window.c * \ingroup wm + * + * Window management, wrap GHOST. */ #include @@ -482,7 +484,7 @@ void wm_window_add_ghostwindows(wmWindowManager *wm) /* new window, no screen yet, but we open ghostwindow for it */ /* also gets the window level handlers */ /* area-rip calls this */ -wmWindow *WM_window_open(bContext *C, rcti *rect) +wmWindow *WM_window_open(bContext *C, const rcti *rect) { wmWindow *win = wm_window_new(C); diff --git a/source/blender/windowmanager/wm_event_system.h b/source/blender/windowmanager/wm_event_system.h index cc139f33c84..df084554c54 100644 --- a/source/blender/windowmanager/wm_event_system.h +++ b/source/blender/windowmanager/wm_event_system.h @@ -50,7 +50,7 @@ typedef struct wmEventHandler { /* keymap handler */ wmKeyMap *keymap; /* pointer to builtin/custom keymaps */ - rcti *bblocal, *bbwin; /* optional local and windowspace bb */ + const rcti *bblocal, *bbwin; /* optional local and windowspace bb */ /* modal operator handler */ wmOperator *op; /* for derived/modal handlers */ -- cgit v1.2.3