Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCampbell Barton <ideasman42@gmail.com>2012-08-13 19:17:15 +0400
committerCampbell Barton <ideasman42@gmail.com>2012-08-13 19:17:15 +0400
commitca7d1ec39d5ee52c5a12cb40344adfe227ea6dcf (patch)
tree682021f83357f581714397f8cd2feba8120a4555 /source/blender/windowmanager/WM_types.h
parent39945fedf32fccf4dae5f83ed08ed34aa799d919 (diff)
style cleanup: use <pre> for doxygen ascii art
Diffstat (limited to 'source/blender/windowmanager/WM_types.h')
-rw-r--r--source/blender/windowmanager/WM_types.h14
1 files changed, 9 insertions, 5 deletions
diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h
index 91f93828235..5f4d3f6194a 100644
--- a/source/blender/windowmanager/WM_types.h
+++ b/source/blender/windowmanager/WM_types.h
@@ -31,10 +31,11 @@
#ifndef __WM_TYPES_H__
#define __WM_TYPES_H__
-/*
+/**
* Overview of WM structs
* ======================
*
+ * <pre>
* > wmWindowManager (window manager stores a list of windows)
* > > wmWindow (window has an active screen)
* > > > bScreen (link to ScrAreas via 'areabase')
@@ -42,11 +43,12 @@
* > > > > > SpaceLink (base struct for space data for all different space types)
* > > > > ScrArea (stores multiple regions via 'regionbase')
* > > > > > ARegion
- *
+ * </pre>
*
* Window Layout
* =============
*
+ * <pre>
* wmWindow -> bScreen
* +----------------------------------------------------------+
* |+-----------------------------------------+-------------+ |
@@ -66,11 +68,12 @@
* ||+-------++----------+-------------------+| | |
* |+-----------------------------------------+-------------+ |
* +----------------------------------------------------------+
- *
+ * </pre>
*
* Space Data
* ==========
*
+ * <pre>
* ScrArea's store a list of space data (SpaceLinks), each of unique type.
* The first one is the displayed in the UI, others are added as needed.
*
@@ -88,14 +91,15 @@
* +-----------------------------+ |
* | |
* +------------------------------+
+ * </pre>
*
* A common way to get the space from the ScrArea:
- *
+ * <pre>
* if (sa->spacetype == SPACE_VIEW3D) {
* View3D *v3d = sa->spacedata.first;
* ...
* }
- *
+ * </pre>
*/
#ifdef __cplusplus