Docs: doxygen file descriptions for BLF, GPU and WM
authorCampbell Barton <ideasman42@gmail.com>
Sun, 19 Jan 2014 12:14:24 +0000 (23:14 +1100)
committerCampbell Barton <ideasman42@gmail.com>
Sun, 19 Jan 2014 12:15:25 +0000 (23:15 +1100)
31 files changed:
source/blender/blenfont/intern/blf.c
source/blender/blenfont/intern/blf_dir.c
source/blender/blenfont/intern/blf_font.c
source/blender/blenfont/intern/blf_glyph.c
source/blender/blenfont/intern/blf_lang.c
source/blender/blenfont/intern/blf_translation.c
source/blender/blenfont/intern/blf_util.c
source/blender/blenlib/intern/task.c
source/blender/bmesh/intern/bmesh_core.c
source/blender/bmesh/tools/bmesh_bevel.c
source/blender/gpu/intern/gpu_buffers.c
source/blender/gpu/intern/gpu_codegen.c
source/blender/gpu/intern/gpu_draw.c
source/blender/gpu/intern/gpu_extensions.c
source/blender/gpu/intern/gpu_material.c
source/blender/gpu/intern/gpu_simple_shader.c
source/blender/windowmanager/WM_api.h
source/blender/windowmanager/intern/wm.c
source/blender/windowmanager/intern/wm_cursors.c
source/blender/windowmanager/intern/wm_dragdrop.c
source/blender/windowmanager/intern/wm_draw.c
source/blender/windowmanager/intern/wm_event_system.c
source/blender/windowmanager/intern/wm_files.c
source/blender/windowmanager/intern/wm_gesture.c
source/blender/windowmanager/intern/wm_init_exit.c
source/blender/windowmanager/intern/wm_jobs.c
source/blender/windowmanager/intern/wm_keymap.c
source/blender/windowmanager/intern/wm_operators.c
source/blender/windowmanager/intern/wm_subwindow.c
source/blender/windowmanager/intern/wm_window.c
source/blender/windowmanager/wm_event_system.h

index 0b6231e5b237a39d94acb4366af498f3efdb9ea7..54f94ad7b87bf6d01eb2f83e24f9471b41c61fae 100644 (file)
 
 /** \file blender/blenfont/intern/blf.c
  *  \ingroup blf
+ *
+ * Main BlenFont (BLF) API, public functions for font handling.
+ *
+ * Wraps OpenGL and FreeType.
  */
 
 #include <stdio.h>
index da4d0b77a732845443448f95ff5942a7e783ed91..4a36ae03bed46471b6b9bc85fbb07871776182cb 100644 (file)
@@ -25,6 +25,8 @@
 
 /** \file blender/blenfont/intern/blf_dir.c
  *  \ingroup blf
+ *
+ * Manage search paths for font files.
  */
 
 
index 5864c17fac4bd67e8a996f114bb7e1a4ccd7443a..846c9cca55ca47216c7680763e3cf52fa34bb227 100644 (file)
 
 /** \file blender/blenfont/intern/blf_font.c
  *  \ingroup blf
+ *
+ * Deals with drawing text to OpenGL or bitmap buffers.
+ *
+ * Also low level functions for managing \a FontBLF.
  */
 
 
index 248c645edc03ecceff7ed6c14a70e918ab59ac1f..7c3cfa30e1698a5d194117d9bc8d07eee569b77e 100644 (file)
@@ -26,6 +26,8 @@
 
 /** \file blender/blenfont/intern/blf_glyph.c
  *  \ingroup blf
+ *
+ * Glyph rendering, texturing and caching. Wraps Freetype and OpenGL functions.
  */
 
 
index 9649e5bc74668c7694aeb7424cc1f421eace7c56..623d8b7652ad7844ec05bfe1d70612b3bf428114 100644 (file)
@@ -25,6 +25,8 @@
 
 /** \file blender/blenfont/intern/blf_lang.c
  *  \ingroup blf
+ *
+ * Main internationalization functions to set the locale and query available languages.
  */
 
 #include <stdio.h>
index 57f442f8bfcf76e29f7c6ee62c6057ba7773d7c7..dc9baf804b34a7419423eddf2887ad9888badc53 100644 (file)
@@ -26,6 +26,9 @@
 
 /** \file blender/blenfont/intern/blf_translation.c
  *  \ingroup blf
+ *
+ * Manages translation files and provides translation functions.
+ * (which are optional and can be disabled as a preference).
  */
 
 #include <stdlib.h>
index 8240906dd3b8f1abaf0630741c840b993bd267a9..cb9b652b8ef965a7fa19c988a53f17ef1a1839cf 100644 (file)
@@ -26,6 +26,8 @@
 
 /** \file blender/blenfont/intern/blf_util.c
  *  \ingroup blf
+ *
+ * Internal utility API for BLF.
  */
 
 
index 4ae60abb2c8fc32b9d90f0abbfe12cff8885bca3..1ac4045ea4966aca0dd7de5a0443048077e86a46 100644 (file)
  * ***** END GPL LICENSE BLOCK *****
  */
 
+/** \file blender/blenlib/intern/task.c
+ *  \ingroup bli
+ *
+ * A generic task system which can be used for any task based subsystem.
+ */
+
 #include <stdlib.h>
 
 #include "MEM_guardedalloc.h"
index 7b3ca89871805bc6454ab4c93b9ca604d76d2302..c635f9d9d06bc083252e9fe03a7f3aed38818cb9 100644 (file)
@@ -23,6 +23,7 @@
 /** \file blender/bmesh/intern/bmesh_core.c
  *  \ingroup bmesh
  *
+ * Core BMesh functions for adding, removing BMesh elements.
  */
 
 #include "MEM_guardedalloc.h"
index d07d833eab97c9dc34b3bb05e0239ff8ddeabfe1..9f2a71e7e296bdd3f91b24c6225a4814be31e385 100644 (file)
@@ -26,6 +26,8 @@
 
 /** \file blender/bmesh/tools/bmesh_bevel.c
  *  \ingroup bmesh
+ *
+ * Main functions for beveling a BMesh (used by the tool and modifier)
  */
 
 #include "MEM_guardedalloc.h"
index f6919e34790bb1a58b4cc55a8584783681b2a5e9..6a6979ed89f8cc1c3888529c80bc7cc57ad4e779 100644 (file)
 
 /** \file blender/gpu/intern/gpu_buffers.c
  *  \ingroup gpu
+ *
+ * Mesh drawing using OpenGL VBO (Vertex Buffer Objects),
+ * with fall-back to vertex arrays.
  */
 
-
 #include <limits.h>
 #include <stddef.h>
 #include <string.h>
index 8e0d0e557097fb02c287c3a754b293b29b821ace..ecd4ad6f0c3b4c08351d19ace21853bb57667b56 100644 (file)
 
 /** \file blender/gpu/intern/gpu_codegen.c
  *  \ingroup gpu
+ *
+ * Convert material node-trees to GLSL.
  */
 
-
 #include "GL/glew.h"
 
 #include "MEM_guardedalloc.h"
index f3f304b0e0443e392b85cf376fe7098d3d889bd5..5ee30c242c1aad61907e5e929b01935710c22438 100644 (file)
 
 /** \file blender/gpu/intern/gpu_draw.c
  *  \ingroup gpu
+ *
+ * Utility functions for dealing with OpenGL texture & material context,
+ * mipmap generation and light objects.
+ *
+ * These are some obscure rendering functions shared between the
+ * game engine and the blender, in this module to avoid duplication
+ * and abstract them away from the rest a bit.
  */
 
-
 #include <string.h>
 
 #include "GL/glew.h"
 
 extern Material defmaterial; /* from material.c */
 
-/* These are some obscure rendering functions shared between the
- * game engine and the blender, in this module to avoid duplicaten
- * and abstract them away from the rest a bit */
-
 /* Text Rendering */
 
 static void gpu_mcol(unsigned int ucol)
index 1d08f1f6ea9631d30e8f8ed7e42c4ceb7ea5cf90..e8fd8eb49d68b3af44d61fbe5c54735afdccc3a1 100644 (file)
@@ -27,6 +27,9 @@
 
 /** \file blender/gpu/intern/gpu_extensions.c
  *  \ingroup gpu
+ *
+ * Wrap OpenGL features such as textures, shaders and GLSL
+ * with checks for drivers and GPU support.
  */
 
 
index a746ac63bda9b8382f5dc50c7bdc5050f77fbb4a..a425153f4034d886f281489c69b1191b60335d61 100644 (file)
@@ -27,6 +27,8 @@
 
 /** \file blender/gpu/intern/gpu_material.c
  *  \ingroup gpu
+ *
+ * Manages materials, lights and textures.
  */
 
 
index 5fb723172ec9e041d0f05f92312b71b9f3970ea5..0cb712d220f614e5b4849f3ba9e28faf341bbcc2 100644 (file)
@@ -27,9 +27,8 @@
 
 /** \file blender/gpu/intern/gpu_simple_shader.c
  *  \ingroup gpu
- */
-
-/* GLSL shaders to replace fixed function OpenGL materials and lighting. These
+ *
+ * GLSL shaders to replace fixed function OpenGL materials and lighting. These
  * are deprecated in newer OpenGL versions and missing in OpenGL ES 2.0. Also,
  * two sided lighting is no longer natively supported on NVidia cards which
  * results in slow software fallback.
index 046152d07a1eb10b4cfb62168ec2c467b81b9913..b635544add0aa7b590ffb9b083dd5b7224f73f31 100644 (file)
@@ -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);
 
index 2fbf92ebed7904a41fb00d87e6b6e2ab8501affd..6a91eca2c7f8f8c55722414020edb39bdda952d1 100644 (file)
 
 /** \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 <string.h>
index 09a83834610d9b18d39067860881f2582c49e212..01cd1514a3a2ee5d25839efb8b41f62e27c42c79 100644 (file)
 
 /** \file blender/windowmanager/intern/wm_cursors.c
  *  \ingroup wm
+ *
+ * Cursor pixmap and cursor utility functions to change the cursor.
  */
 
-
 #include <stdio.h>
 #include <string.h>
 
index 12e23c3d0c708d6fd60114779f1339d34edb0bf9..7675d4d4418a2e4c2d28e044f05108d044e58608 100644 (file)
 
 /** \file blender/windowmanager/intern/wm_dragdrop.c
  *  \ingroup wm
+ *
+ * Our own drag-and-drop, drag state and drop boxes.
  */
 
-
 #include <string.h>
 
 #include "DNA_windowmanager_types.h"
index b4d29f05e15c25442b9458caad1587d7f5ed5433..e89980f53fc35e4371cb9fad9d1707a0c0e3aa5e 100644 (file)
 
 /** \file blender/windowmanager/intern/wm_draw.c
  *  \ingroup wm
+ *
+ * Handle OpenGL buffers for windowing, also paint cursor.
  */
 
-
 #include <stdlib.h>
 #include <string.h>
 #include <GL/glew.h>
index f8488b63c8529678d912f5b701fbfaeb99005cb5..308c14814afca3ec06db358214c75340b347760d 100644 (file)
 
 /** \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);
        
index 9c479a2b86867374627aab730959932f559c90fb..55f0d922005d466ed2b66986c117245cd2f21c89 100644 (file)
@@ -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);
 }
 
-
-
-
index 83cb6fd83d1c07b29cf714322b461e8c2288de6c..6e34c77671926cac49738c03b152a815ff09ccd2 100644 (file)
 
 /** \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"
 
index 8b43a6af606ef9c80c0199d63a2f01da47d3efc1..5196b584816026e6848693da6ddb39b484226439 100644 (file)
@@ -26,6 +26,8 @@
 
 /** \file blender/windowmanager/intern/wm_init_exit.c
  *  \ingroup wm
+ *
+ * Manage initializing resources and correctly shutting down.
  */
 
 #include <stdlib.h>
index 7da9a1c09d3aea36609158976813750e66786d37..4cf5813d0805327ed21363d0fea05f05f852026e 100644 (file)
 
 /** \file blender/windowmanager/intern/wm_jobs.c
  *  \ingroup wm
+ *
+ * Threaded job manager (high level job access).
  */
 
-
 #include <string.h>
 
 #include "DNA_windowmanager_types.h"
@@ -56,8 +57,6 @@
 
 #include "PIL_time.h"
 
-/* ********************** Threaded Jobs Manager ****************************** */
-
 /*
  * Add new job
  * - register in WM
index 4758ba5d7753c1d62e694115d5b6db1623a167c6..36099d5de8e0ef340cb1b126b21e85429e4ef592 100644 (file)
 
 /** \file blender/windowmanager/intern/wm_keymap.c
  *  \ingroup wm
+ *
+ * Configurable key-maps - add/remove/find/compare/patch...
  */
 
-
 #include <string.h>
 
 #include "DNA_object_types.h"
index 38e9b6d7d33b4566b61b61e4e3427b173bba5d5a..255d6f19789b011756c47ffa2235e5abd6b6aa40 100644 (file)
@@ -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.
  */
 
 
index 75608a850ac5e46541c6cc979bc07022d314c979..10a24338b35321c19f61162341b40e6cce479013 100644 (file)
 
 /** \file blender/windowmanager/intern/wm_subwindow.c
  *  \ingroup wm
+ *
+ * Internal subwindows used for OpenGL state, used for regions and screens.
  */
 
-
 #include <string.h>
 
 #include "MEM_guardedalloc.h"
index 1e682be603be8681e7762116c6a6aa2009bb5e14..f2f9443c1118a14906c321fce339e5592c8403d3 100644 (file)
@@ -26,6 +26,8 @@
 
 /** \file blender/windowmanager/intern/wm_window.c
  *  \ingroup wm
+ *
+ * Window management, wrap GHOST.
  */
 
 #include <math.h>
@@ -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);
        
index cc139f33c849ee707a3bb47903a0132899354fae..df084554c5478fdb70f57c44f7bd8b1a7444f471 100644 (file)
@@ -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 */