From 8f01b50e147b701fb0b3e2251fec88bec645df50 Mon Sep 17 00:00:00 2001
From: Campbell Barton <ideasman42@gmail.com>
Date: Sat, 2 Mar 2013 07:27:19 +0000
Subject: code cleanup: clarify comment about virtial-modifiers, also add
 comments to DNA headers when its not so obvious what their purpose is.

---
 source/blender/makesdna/DNA_action_types.h     |  6 +++++-
 source/blender/makesdna/DNA_actuator_types.h   |  6 +++---
 source/blender/makesdna/DNA_controller_types.h |  5 +++--
 source/blender/makesdna/DNA_customdata_types.h |  4 +++-
 source/blender/makesdna/DNA_defs.h             |  2 ++
 source/blender/makesdna/DNA_group_types.h      |  4 +++-
 source/blender/makesdna/DNA_mask_types.h       |  3 +++
 source/blender/makesdna/DNA_property_types.h   |  5 +++--
 source/blender/makesdna/DNA_sensor_types.h     |  4 +++-
 source/blender/makesdna/DNA_sequence_types.h   | 10 +++++++++-
 source/blender/makesdna/DNA_space_types.h      |  4 +++-
 source/blender/makesdna/DNA_text_types.h       |  5 ++++-
 source/blender/makesdna/DNA_tracking_types.h   |  4 +++-
 source/blender/makesdna/DNA_vfont_types.h      |  5 ++++-
 14 files changed, 51 insertions(+), 16 deletions(-)

(limited to 'source/blender/makesdna')

diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h
index f227af78dab..b27abb519d9 100644
--- a/source/blender/makesdna/DNA_action_types.h
+++ b/source/blender/makesdna/DNA_action_types.h
@@ -27,6 +27,10 @@
 
 /** \file DNA_action_types.h
  *  \ingroup DNA
+ *
+ * Define actions data-block for the animation system.
+ * A collection of animation curves and drivers to be assigned to data-blocks
+ * or sequenced in the non-linear-editor (NLA).
  */
 
 #ifndef __DNA_ACTION_TYPES_H__
@@ -689,4 +693,4 @@ typedef enum ACHAN_FLAG {
 	ACHAN_MOVED     = (1 << 31)
 } ACHAN_FLAG; 
 
-#endif
+#endif  /* __DNA_ACTION_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_actuator_types.h b/source/blender/makesdna/DNA_actuator_types.h
index 7c4772f24e8..1495ba1b1a5 100644
--- a/source/blender/makesdna/DNA_actuator_types.h
+++ b/source/blender/makesdna/DNA_actuator_types.h
@@ -27,6 +27,8 @@
 
 /** \file DNA_actuator_types.h
  *  \ingroup DNA
+ *
+ * #bActuator type is specifically for use by Object logic-bricks in the game-engine.
  */
 
 #ifndef __DNA_ACTUATOR_TYPES_H__
@@ -535,6 +537,4 @@ typedef struct bActuator {
 #define ACT_STEERING_AUTOMATICFACING   4
 #define ACT_STEERING_NORMALUP  8
 
-#endif
-
-
+#endif  /* __DNA_ACTUATOR_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_controller_types.h b/source/blender/makesdna/DNA_controller_types.h
index bdfedb5b4d1..0c1aaf5fd20 100644
--- a/source/blender/makesdna/DNA_controller_types.h
+++ b/source/blender/makesdna/DNA_controller_types.h
@@ -27,6 +27,8 @@
 
 /** \file DNA_controller_types.h
  *  \ingroup DNA
+ *
+ * #bController type is specifically for use by Object logic-bricks in the game-engine.
  */
 
 #ifndef __DNA_CONTROLLER_TYPES_H__
@@ -89,5 +91,4 @@ typedef struct bController {
 #define CONT_PY_SCRIPT	0
 #define CONT_PY_MODULE	1
 
-#endif
-
+#endif  /* __DNA_CONTROLLER_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_customdata_types.h b/source/blender/makesdna/DNA_customdata_types.h
index e28b8780250..4a3debe756b 100644
--- a/source/blender/makesdna/DNA_customdata_types.h
+++ b/source/blender/makesdna/DNA_customdata_types.h
@@ -27,6 +27,8 @@
 
 /** \file DNA_customdata_types.h
  *  \ingroup DNA
+ *
+ * Used for custom mesh data types (stored per vert/edge/loop/face)
  */
 
 #ifndef __DNA_CUSTOMDATA_TYPES_H__
@@ -177,4 +179,4 @@ typedef struct CustomData {
 }
 #endif
 
-#endif
+#endif  /* __DNA_CUSTOMDATA_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_defs.h b/source/blender/makesdna/DNA_defs.h
index 774fbcf081a..ffe4fc970b1 100644
--- a/source/blender/makesdna/DNA_defs.h
+++ b/source/blender/makesdna/DNA_defs.h
@@ -22,6 +22,8 @@
 
 /** \file DNA_defs.h
  *  \ingroup DNA
+ *
+ * Group generic defines for all DNA headers may use in this file.
  */
 
 #ifndef __DNA_DEFS_H__
diff --git a/source/blender/makesdna/DNA_group_types.h b/source/blender/makesdna/DNA_group_types.h
index a084bee1c2d..2740281b4c0 100644
--- a/source/blender/makesdna/DNA_group_types.h
+++ b/source/blender/makesdna/DNA_group_types.h
@@ -27,6 +27,8 @@
 
 /** \file DNA_group_types.h
  *  \ingroup DNA
+ *
+ * \brief Object groups, one object can be in many groups at once.
  */
 
 #ifndef __DNA_GROUP_TYPES_H__
@@ -58,4 +60,4 @@ typedef struct Group {
 	float dupli_ofs[3];
 } Group;
 
-#endif
+#endif  /* __DNA_GROUP_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_mask_types.h b/source/blender/makesdna/DNA_mask_types.h
index 5b25d1a072c..1b6b802f2de 100644
--- a/source/blender/makesdna/DNA_mask_types.h
+++ b/source/blender/makesdna/DNA_mask_types.h
@@ -30,6 +30,9 @@
  *  \ingroup DNA
  *  \since march-2012
  *  \author Sergey Sharybin
+ *
+ * Mask data-blocks are collections of 2D curves to be used
+ * for image masking in the compositor and sequencer.
  */
 
 #ifndef __DNA_MASK_TYPES_H__
diff --git a/source/blender/makesdna/DNA_property_types.h b/source/blender/makesdna/DNA_property_types.h
index c1b810cd42b..c8275a41404 100644
--- a/source/blender/makesdna/DNA_property_types.h
+++ b/source/blender/makesdna/DNA_property_types.h
@@ -31,6 +31,8 @@
  *  \author nzc
  *  \attention Renderrecipe and scene decription. The fact that there is a
  *             hierarchy here is a bit strange, and not desirable.
+ *
+ * #bProperty type is specifically for use by Objects game-logic.
  */
 
 #ifndef __DNA_PROPERTY_TYPES_H__
@@ -60,5 +62,4 @@ typedef struct bProperty {
 
 #define MAX_PROPSTRING	128
 
-#endif
-
+#endif  /* __DNA_PROPERTY_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_sensor_types.h b/source/blender/makesdna/DNA_sensor_types.h
index 05927e3a486..d8cf80d047b 100644
--- a/source/blender/makesdna/DNA_sensor_types.h
+++ b/source/blender/makesdna/DNA_sensor_types.h
@@ -29,6 +29,8 @@
  *  \ingroup DNA
  *  \since mar-2001
  *  \author nzc
+ *
+ * #bSensor type is specifically for use by Object logic-bricks in the game-engine.
  */
 
 #ifndef __DNA_SENSOR_TYPES_H__
@@ -324,5 +326,5 @@ typedef struct bJoystickSensor {
 #define SENS_DELAY_REPEAT		1
 // should match JOYINDEX_MAX in SCA_JoystickDefines.h */
 #define SENS_JOY_MAXINDEX		8
-#endif
 
+#endif  /* __DNA_SENSOR_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_sequence_types.h b/source/blender/makesdna/DNA_sequence_types.h
index 0aa466f7245..455350d8310 100644
--- a/source/blender/makesdna/DNA_sequence_types.h
+++ b/source/blender/makesdna/DNA_sequence_types.h
@@ -28,6 +28,14 @@
  *  \ingroup DNA
  *  \since mar-2001
  *  \author nzc
+ *
+ * Structs for use by the 'Sequencer' (Video Editor)
+ *
+ * Note on terminology
+ * - #Sequence: video/effect/audio data you can select and manipulate in the sequencer.
+ * - #Sequence.machine: Strange name for the channel.
+ * - #Strip: The data referenced by the #Sequence
+ * - Meta Strip (SEQ_TYPE_META): Support for nesting Sequences.
  */
 
 #ifndef __DNA_SEQUENCE_TYPES_H__
@@ -441,4 +449,4 @@ enum {
 	SEQUENCE_MASK_INPUT_ID      = 1
 };
 
-#endif
+#endif  /* __DNA_SEQUENCE_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h
index 4c28199481f..0873c2278c5 100644
--- a/source/blender/makesdna/DNA_space_types.h
+++ b/source/blender/makesdna/DNA_space_types.h
@@ -28,6 +28,8 @@
  *  \ingroup DNA
  *  \since mar-2001
  *  \author nzc
+ *
+ * Structs for each of space type in the user interface.
  */
 
 #ifndef __DNA_SPACE_TYPES_H__
@@ -1133,4 +1135,4 @@ typedef enum eSpace_Type {
 
 #define IMG_SIZE_FALLBACK 256
 
-#endif
+#endif  /* __DNA_SPACE_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_text_types.h b/source/blender/makesdna/DNA_text_types.h
index 3194adba3a0..8b18ecd7253 100644
--- a/source/blender/makesdna/DNA_text_types.h
+++ b/source/blender/makesdna/DNA_text_types.h
@@ -28,6 +28,9 @@
  *  \ingroup DNA
  *  \since mar-2001
  *  \author nzc
+ *
+ * Text blocks used for Python-Scripts, OpenShadingLanguage
+ * and arbitrary text data to store in blend files.
  */
 
 #ifndef __DNA_TEXT_TYPES_H__
@@ -75,4 +78,4 @@ typedef struct Text {
 #define TXT_FOLLOW              0x0200 /* always follow cursor (console) */
 #define TXT_TABSTOSPACES        0x0400 /* use space instead of tabs */
 
-#endif
+#endif  /* __DNA_TEXT_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_tracking_types.h b/source/blender/makesdna/DNA_tracking_types.h
index 8789a17a7f7..73cda070fd2 100644
--- a/source/blender/makesdna/DNA_tracking_types.h
+++ b/source/blender/makesdna/DNA_tracking_types.h
@@ -30,6 +30,8 @@
  *  \ingroup DNA
  *  \since may-2011
  *  \author Sergey Sharybin
+ *
+ * Structs used for camera tracking and the movie-clip editor.
  */
 
 #ifndef __DNA_TRACKING_TYPES_H__
@@ -431,4 +433,4 @@ enum {
 	TRACKING_COVERAGE_OK         = 2
 };
 
-#endif
+#endif  /* __DNA_TRACKING_TYPES_H__ */
diff --git a/source/blender/makesdna/DNA_vfont_types.h b/source/blender/makesdna/DNA_vfont_types.h
index 7aaeaf23db2..416c5f594a3 100644
--- a/source/blender/makesdna/DNA_vfont_types.h
+++ b/source/blender/makesdna/DNA_vfont_types.h
@@ -29,6 +29,9 @@
  *  \ingroup DNA
  *  \since mar-2001
  *  \author nzc
+ *
+ * Vector Fonts used for text in the 3D view-port
+ * (unrelated to text used to render the GUI).
  */
 
 #ifndef __DNA_VFONT_TYPES_H__
@@ -63,5 +66,5 @@ typedef struct VFont {
 #define FO_SELCHANGE	10
 
 #define FO_BUILTIN_NAME "<builtin>"
-#endif
 
+#endif  /* __DNA_VFONT_TYPES_H__ */
-- 
cgit v1.2.3