From a3e2076bc4f7330188fbb1b3338c9235a7b0bc96 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Sun, 7 Jul 2019 15:22:16 +1000
Subject: Docs: update window/screen introduction

Include global region/areas.
---
 source/blender/windowmanager/WM_types.h | 44 ++++++++++++++++++++++-----------
 1 file changed, 29 insertions(+), 15 deletions(-)

(limited to 'source')

diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h
index 7015f3cc02f..a0c7e8ef752 100644
--- a/source/blender/windowmanager/WM_types.h
+++ b/source/blender/windowmanager/WM_types.h
@@ -19,24 +19,35 @@
 
 /** \file
  * \ingroup wm
- */
-
-#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')
- * > > > > ScrArea      (stores multiple spaces via space links via 'spacedata')
- * > > > > > SpaceLink  (base struct for space data for all different space types)
- * > > > > ScrArea      (stores multiple regions via 'regionbase')
- * > > > > > ARegion
- * </pre>
+ * - #wmWindowManager.windows -> #wmWindow <br>
+ *   Window manager stores a list of windows.
+ *
+ *   - #wmWindow.screen -> #bScreen <br>
+ *     Window has an active screen.
+ *
+ *     - #bScreen.areabase -> #ScrArea <br>
+ *       Link to #ScrArea.
+ *
+ *       - #ScrArea.spacedata <br>
+ *         Stores multiple spaces via space links.
+ *
+ *         - #SpaceLink <br>
+ *           Base struct for space data for all different space types.
+ *
+ *       - #ScrArea.regionbase -> #ARegion <br>
+ *         Stores multiple regions.
+ *
+ *     - #bScreen.regionbase -> #ARegion <br>
+ *       Global screen level regions, e.g. popups, popovers, menus.
+ *
+ *   - #wmWindow.global_areas -> #ScrAreaMap <br>
+ *     Global screen via 'areabase', e.g. top-bar & status-bar.
+ *
  *
  * Window Layout
  * =============
@@ -95,6 +106,9 @@
  * \endcode
  */
 
+#ifndef __WM_TYPES_H__
+#define __WM_TYPES_H__
+
 #ifdef __cplusplus
 extern "C" {
 #endif
-- 
cgit v1.2.3