added commends to some DNA_*.h files - as well as some TODO's for removal.

header_view3d.c was doign an implicit declaration also.

10 files changed, 34 insertions, 19 deletions

diff --git a/source/blender/makesdna/DNA_group_types.h b/source/blender/makesdna/DNA_group_types.h
index 34764fac47d..3a074dd63bc 100644
--- a/source/blender/makesdna/DNA_group_types.h
+++ b/source/blender/makesdna/DNA_group_types.h
@@ -52,6 +52,10 @@ typedef struct Group {
 	ID id;
 	
 	ListBase gobject;	/* GroupObject */
+	
+	/* Bad design, since layers stored in the scenes 'Base'
+	 * the objects that show in the group can change depending
+	 * on the last used scene */
 	unsigned int layer;
 	int pad;
 } Group;
diff --git a/source/blender/makesdna/DNA_image_types.h b/source/blender/makesdna/DNA_image_types.h
index a18493ea189..cf13a1116a9 100644
--- a/source/blender/makesdna/DNA_image_types.h
+++ b/source/blender/makesdna/DNA_image_types.h
@@ -67,7 +67,7 @@ typedef struct ImageUser {
 typedef struct Image {
 	ID id;
 	
-	char name[240];
+	char name[240];			/* file path */
 	
 	ListBase ibufs;			/* not written in file */
 	
diff --git a/source/blender/makesdna/DNA_lamp_types.h b/source/blender/makesdna/DNA_lamp_types.h
index 22696c48878..104b13ea24c 100644
--- a/source/blender/makesdna/DNA_lamp_types.h
+++ b/source/blender/makesdna/DNA_lamp_types.h
@@ -54,7 +54,7 @@ typedef struct Lamp {
 	
 	float energy, dist, spotsize, spotblend;
 	float haint;
-	float att1, att2;
+	float att1, att2;	/* Quad1 and Quad2 attenuation */
 	
 	float clipsta, clipend, shadspotsize;
 	float bias, soft;
diff --git a/source/blender/makesdna/DNA_mesh_types.h b/source/blender/makesdna/DNA_mesh_types.h
index 5f2a77b8349..04d5f2124c4 100644
--- a/source/blender/makesdna/DNA_mesh_types.h
+++ b/source/blender/makesdna/DNA_mesh_types.h
@@ -61,19 +61,19 @@ typedef struct Mesh {
 	struct Key *key;
 	struct Material **mat;
 
-	struct MFace *mface;
-	struct MTFace *mtface;
+	struct MFace *mface;	/* array of mesh object mode faces */
+	struct MTFace *mtface;	/* store face UV's and texture here */
 	struct TFace *tface;	/* depecrated, use mtface */
-	struct MVert *mvert;
-	struct MEdge *medge;
+	struct MVert *mvert;	/* array of verts */
+	struct MEdge *medge;	/* array of edges */
 	struct MDeformVert *dvert;	/* __NLA */
-	struct MCol *mcol;
+	struct MCol *mcol;		/* array of colors, this must be the number of faces * 4 */
 	struct MSticky *msticky;
 	struct Mesh *texcomesh;
 	struct MSelect *mselect;
 	
-	struct OcInfo *oc;		/* not written in file */
-	void *sumohandle;
+	struct OcInfo *oc;		/* not written in file - TODO remove this! */
+	void *sumohandle;		/* this is not used anywhere anymore - TODO remove this too (Campbell)*/
 
 	struct CustomData vdata, edata, fdata;
 
@@ -91,7 +91,7 @@ typedef struct Mesh {
 
 	short subdiv, subdivr;
 	short totcol;
-	short subsurftype; 
+	short subsurftype;		/* only kept for backwards compat, not used anymore */
 
 	struct Multires *mr;		/* Multiresolution modeling data */
 	struct PartialVisibility *pv;
@@ -103,7 +103,7 @@ typedef struct Mesh {
 
 /* deprecated by MTFace, only here for file reading */
 typedef struct TFace {
-	void *tpage;
+	void *tpage;	/* the faces image for the active UVLayer */
 	float uv[4][2];
 	unsigned int col[4];
 	char flag, transp;
diff --git a/source/blender/makesdna/DNA_meshdata_types.h b/source/blender/makesdna/DNA_meshdata_types.h
index 08b8ff038f0..2cbe03ab4cc 100644
--- a/source/blender/makesdna/DNA_meshdata_types.h
+++ b/source/blender/makesdna/DNA_meshdata_types.h
@@ -66,8 +66,10 @@ typedef struct MVert {
 	char flag, mat_nr;
 } MVert;
 
+/* at the moment alpha is abused for vertex painting
+ * and not used for transperency, note that red and blue are swapped */
 typedef struct MCol {
-	char a, r, g, b;
+	char a, r, g, b;	
 } MCol;
 
 typedef struct MSticky {
@@ -231,6 +233,8 @@ typedef struct PartialVisibility {
 #define TF_SOLID	0
 #define TF_ADD		1
 #define TF_ALPHA	2
+
+/* sub is not available in the user interface anymore */
 #define TF_SUB		3
 
 /* mtface->unwrap */
diff --git a/source/blender/makesdna/DNA_nla_types.h b/source/blender/makesdna/DNA_nla_types.h
index 914e6337474..7c4b6bebca4 100644
--- a/source/blender/makesdna/DNA_nla_types.h
+++ b/source/blender/makesdna/DNA_nla_types.h
@@ -88,7 +88,7 @@ typedef struct bActionStrip {
 /* strip->flag */
 #define ACTSTRIP_SELECT			0x01
 #define ACTSTRIP_USESTRIDE		0x02
-#define ACTSTRIP_BLENDTONEXT	0x04
+#define ACTSTRIP_BLENDTONEXT	0x04	/* This is not used anywhere */
 #define ACTSTRIP_HOLDLASTFRAME	0x08
 #define ACTSTRIP_ACTIVE			0x10
 #define ACTSTRIP_LOCK_ACTION	0x20
diff --git a/source/blender/makesdna/DNA_object_types.h b/source/blender/makesdna/DNA_object_types.h
index eb76f9ea9c1..10d93205ed7 100644
--- a/source/blender/makesdna/DNA_object_types.h
+++ b/source/blender/makesdna/DNA_object_types.h
@@ -69,7 +69,8 @@ typedef struct BoundBox {
 /* boundbox flag */
 #define OB_BB_DISABLED	1
 
-/* OcInfo and LBuf structs are for the Enji gameengine */
+/* OcInfo and LBuf structs are for the Enji gameengine
+ * These structs are not needed anymore, both should be removed */
 
 typedef struct OcInfo {
 	float dvec[3];
@@ -102,7 +103,7 @@ typedef struct Object {
 	
 	ListBase constraintChannels;
 	ListBase effect;
-	ListBase network;
+	ListBase network;	/* This is not used anywhere - TODO, should be removed (Campbell)*/
 	ListBase disp;
 	ListBase defbase;
 	ListBase modifiers; /* list of ModifierData structures */
@@ -154,7 +155,7 @@ typedef struct Object {
 	
 	char dt, dtx;
 	char totcol;	/* copy of mesh or curve or meta */
-	char actcol;
+	char actcol;	/* currently selected material in the user interface */
 	char empty_drawtype, pad1[7];
 	float empty_drawsize;
 	
@@ -164,12 +165,14 @@ typedef struct Object {
 	ListBase controllers;
 	ListBase actuators;
 
-    void *sumohandle;
+	/* now used to store cache particles,
+	 * should be renamed see effect.c (Campbell) */
+    void *sumohandle;		
     
 	float bbsize[3];
 	short index;			/* custom index, for renderpasses */
 	unsigned short actdef;	/* current deformation group */
-	float col[4];
+	float col[4];			/* object color, adjusted via IPO's only */
 	/**
 	 * Settings for game objects
 	 * bit 0: Object has dynamic behaviour
@@ -218,6 +221,7 @@ typedef struct Object {
 /*#endif*/
 } Object;
 
+/* Warning, this is not used anymore because hooks are now modifiers */
 typedef struct ObHook {
 	struct ObHook *next, *prev;
 	
diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h
index 5eaec3480ce..21411528e21 100644
--- a/source/blender/makesdna/DNA_scene_types.h
+++ b/source/blender/makesdna/DNA_scene_types.h
@@ -424,7 +424,7 @@ typedef struct Scene {
 	
 	void *ed;
 	struct Radio *radio;
-	void *sumohandle;
+	void *sumohandle;		/* TODO - remove this, its not ued anywhere (Campbell) */
 	
 	struct GameFraming framing;
 
diff --git a/source/blender/makesdna/DNA_world_types.h b/source/blender/makesdna/DNA_world_types.h
index 03b6871b8e0..4b8dfe3812a 100644
--- a/source/blender/makesdna/DNA_world_types.h
+++ b/source/blender/makesdna/DNA_world_types.h
@@ -55,6 +55,7 @@ typedef struct World {
 	short colormodel, totex;
 	short texact, mistype;
 	
+	/* TODO - hork, zenk and ambk are not used, should remove at some point (Campbell) */
 	float horr, horg, horb, hork;
 	float zenr, zeng, zenb, zenk;
 	float ambr, ambg, ambb, ambk;
diff --git a/source/blender/src/header_view3d.c b/source/blender/src/header_view3d.c
index 4a1c71c91a3..4dc8759f859 100644
--- a/source/blender/src/header_view3d.c
+++ b/source/blender/src/header_view3d.c
@@ -2589,6 +2589,8 @@ static uiBlock *view3d_edit_mesh_verticesmenu(void *arg_unused)
 	return block;
 }
 
+extern void editmesh_mark_sharp(int set); /* declared in editmesh_mods.c */
+
 void do_view3d_edit_mesh_edgesmenu(void *arg, int event)
 {
 	float fac;