Merged changes in the trunk up to revision 49986.

1 files changed, 26 insertions, 22 deletions

diff --git a/source/blender/windowmanager/WM_types.h b/source/blender/windowmanager/WM_types.h
index bcba7a76ec8..1f0a0d87cf4 100644
--- a/source/blender/windowmanager/WM_types.h
+++ b/source/blender/windowmanager/WM_types.h
@@ -28,10 +28,14 @@
  *  \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')
@@ -39,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
  * +----------------------------------------------------------+
  * |+-----------------------------------------+-------------+ |
@@ -63,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.
  *
@@ -85,19 +91,17 @@
  *    +-----------------------------+   |
  *       |                              |
  *       +------------------------------+
+ * </pre>
  *
  * A common way to get the space from the ScrArea:
- *
+ * <pre>
  *     if (sa->spacetype == SPACE_VIEW3D) {
  *         View3D *v3d = sa->spacedata.first;
  *         ...
  *     }
- *
+ * </pre>
  */
 
-#ifndef __WM_TYPES_H__
-#define __WM_TYPES_H__
-
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -455,28 +459,28 @@ typedef struct wmTabletData {
 
 typedef enum {  /* motion progress, for modal handlers */
 	P_NOT_STARTED,
-	P_STARTING,    // <--
-	P_IN_PROGRESS, // <-- only these are sent for NDOF motion
-	P_FINISHING,   // <--
+	P_STARTING,    /* <-- */
+	P_IN_PROGRESS, /* <-- only these are sent for NDOF motion*/
+	P_FINISHING,   /* <-- */
 	P_FINISHED
-	} wmProgress;
+} wmProgress;
 
 typedef struct wmNDOFMotionData {
 	/* awfully similar to GHOST_TEventNDOFMotionData... */
-	// Each component normally ranges from -1 to +1, but can exceed that.
-	// These use blender standard view coordinates, with positive rotations being CCW about the axis.
+	/* Each component normally ranges from -1 to +1, but can exceed that.
+	 * These use blender standard view coordinates, with positive rotations being CCW about the axis. */
 	union {
-		float tvec[3]; // translation
+		float tvec[3]; /* translation */
 		struct { float tx, ty, tz; };
-		};
+	};
 	union {
-		float rvec[3]; // rotation:
+		float rvec[3]; /* rotation: */
 		struct { float rx, ry, rz; };
-		};
-		// axis = (rx,ry,rz).normalized
-		// amount = (rx,ry,rz).magnitude [in revolutions, 1.0 = 360 deg]
-	float dt; // time since previous NDOF Motion event
-	wmProgress progress; // is this the first event, the last, or one of many in between?
+	};
+	/* axis = (rx,ry,rz).normalized */
+	/* amount = (rx,ry,rz).magnitude [in revolutions, 1.0 = 360 deg] */
+	float dt; /* time since previous NDOF Motion event */
+	wmProgress progress; /* is this the first event, the last, or one of many in between? */
 } wmNDOFMotionData;
 
 typedef struct wmTimer {