added "description" and "readonly" properties to RNA Structs (also accessible via...
authorCampbell Barton <ideasman42@gmail.com>
Fri, 19 Dec 2008 04:06:24 +0000 (04:06 +0000)
committerCampbell Barton <ideasman42@gmail.com>
Fri, 19 Dec 2008 04:06:24 +0000 (04:06 +0000)
Many descriptions are not written, grep for DOC_BROKEN if you have some spare time to write struct descriptions.

41 files changed:
source/blender/makesrna/RNA_access.h
source/blender/makesrna/RNA_define.h
source/blender/makesrna/RNA_types.h
source/blender/makesrna/intern/makesrna.c
source/blender/makesrna/intern/rna_ID.c
source/blender/makesrna/intern/rna_access.c
source/blender/makesrna/intern/rna_actuator.c
source/blender/makesrna/intern/rna_armature.c
source/blender/makesrna/intern/rna_brush.c
source/blender/makesrna/intern/rna_camera.c
source/blender/makesrna/intern/rna_color.c
source/blender/makesrna/intern/rna_constraint.c
source/blender/makesrna/intern/rna_controller.c
source/blender/makesrna/intern/rna_curve.c
source/blender/makesrna/intern/rna_define.c
source/blender/makesrna/intern/rna_group.c
source/blender/makesrna/intern/rna_image.c
source/blender/makesrna/intern/rna_internal_types.h
source/blender/makesrna/intern/rna_ipo.c
source/blender/makesrna/intern/rna_key.c
source/blender/makesrna/intern/rna_lamp.c
source/blender/makesrna/intern/rna_lattice.c
source/blender/makesrna/intern/rna_main.c
source/blender/makesrna/intern/rna_material.c
source/blender/makesrna/intern/rna_mesh.c
source/blender/makesrna/intern/rna_meta.c
source/blender/makesrna/intern/rna_modifier.c
source/blender/makesrna/intern/rna_nodetree.c
source/blender/makesrna/intern/rna_object.c
source/blender/makesrna/intern/rna_packedfile.c
source/blender/makesrna/intern/rna_property.c
source/blender/makesrna/intern/rna_radio.c
source/blender/makesrna/intern/rna_rna.c
source/blender/makesrna/intern/rna_scene.c
source/blender/makesrna/intern/rna_screen.c
source/blender/makesrna/intern/rna_sensor.c
source/blender/makesrna/intern/rna_sequence.c
source/blender/makesrna/intern/rna_vfont.c
source/blender/makesrna/intern/rna_wm.c
source/blender/makesrna/intern/rna_world.c
source/blender/windowmanager/intern/wm_operators.c

index 28359f7ccbec01b20e5a2c52a9745092418806b1..00e4ef299b15aead152636946e34bc96de708eb5 100644 (file)
@@ -187,6 +187,7 @@ void RNA_blender_rna_pointer_create(PointerRNA *r_ptr);
 
 const char *RNA_struct_identifier(PointerRNA *ptr);
 const char *RNA_struct_ui_name(PointerRNA *ptr);
+const char *RNA_struct_ui_description(PointerRNA *ptr);
 
 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr);
 PropertyRNA *RNA_struct_iterator_property(PointerRNA *ptr);
@@ -332,3 +333,4 @@ int RNA_property_is_set(PointerRNA *ptr, const char *name);
 #endif /* RNA_ACCESS */
 
 
+
index c437b9a840f3426eb922e950ac048d2ff52bd962..d7df58ca61ccb1de8761c3e09997eb0456238943 100644 (file)
@@ -39,13 +39,14 @@ void RNA_exit(void);
 
 /* Struct */
 
-StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from, const char *name);
+StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from);
 void RNA_def_struct_sdna(StructRNA *srna, const char *structname);
 void RNA_def_struct_sdna_from(StructRNA *srna, const char *structname, const char *propname);
 void RNA_def_struct_name_property(StructRNA *srna, PropertyRNA *prop);
 void RNA_def_struct_flag(StructRNA *srna, int flag);
 void RNA_def_struct_funcs(StructRNA *srna, const char *notify, const char *refine);
-void RNA_def_struct_identifier(StructRNA *srna, const char *identifier, const char *name);
+void RNA_def_struct_identifier(StructRNA *srna, const char *identifier);
+void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description);
 
 /* Property */
 
@@ -92,3 +93,4 @@ void RNA_def_property_collection_funcs(PropertyRNA *prop, const char *begin, con
 
 #endif /* RNA_DEFINE_H */
 
+
index d13c91d3b7eade1ae05ed7c29a16236a18b48dbc..fac42821e09611b4b6cc146f4d61eb88c228f32b 100644 (file)
@@ -144,3 +144,4 @@ typedef struct BlenderRNA BlenderRNA;
 
 #endif /* RNA_TYPES */
 
+
index cb54783389d9d032b9dbdff7bdc035d296769001..835b6fc7f42a9131db4d5b18799634d7b31c6515 100644 (file)
@@ -861,6 +861,8 @@ static void rna_generate_struct(BlenderRNA *brna, StructRNA *srna, FILE *f)
        rna_print_c_string(f, srna->identifier);
        fprintf(f, ", %d, ", srna->flag);
        rna_print_c_string(f, srna->name);
+       fprintf(f, ", ");
+       rna_print_c_string(f, srna->description);
        fprintf(f, ",\n");
 
        prop= srna->nameproperty;
index fed87bc46389d30e47fab8427d8fc61fec720fbc..dc36349e19ba5d7dc8cd002ce9a0af9b9beea0b5 100644 (file)
@@ -106,7 +106,9 @@ static void rna_def_ID_properties(BlenderRNA *brna)
 
        /* this is struct is used for holding the virtual
         * PropertyRNA's for ID properties */
-       srna= RNA_def_struct(brna, "IDProperty", NULL, "ID Property");
+       srna= RNA_def_struct(brna, "IDProperty", NULL);
+       RNA_def_struct_ui_text(srna, "ID Property", "stores arbitrary properties");
+       
 
        /* IDP_STRING */
        prop= RNA_def_property(srna, "string", PROP_STRING, PROP_NONE);
@@ -146,7 +148,8 @@ static void rna_def_ID_properties(BlenderRNA *brna)
        /* ID property groups > level 0, since level 0 group is merged
         * with native RNA properties. the builtin_properties will take
         * care of the properties here */
-       srna= RNA_def_struct(brna, "IDPropertyGroup", NULL, "ID Property Group");
+       srna= RNA_def_struct(brna, "IDPropertyGroup", NULL);
+       RNA_def_struct_ui_text(srna, "ID Property Group", "a collection of properties");
 }
 
 static void rna_def_ID(BlenderRNA *brna)
@@ -154,7 +157,9 @@ static void rna_def_ID(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "ID", NULL, "ID");
+       srna= RNA_def_struct(brna, "ID", NULL);
+       RNA_def_struct_ui_text(srna, "ID", "Used as a basis for dealing with many types with unique names, garbage collection and linked libraries");
+       
        RNA_def_struct_flag(srna, STRUCT_ID);
        RNA_def_struct_funcs(srna, NULL, "rna_ID_refine");
 
@@ -186,7 +191,8 @@ static void rna_def_library(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "Library", "ID", "Library");
+       srna= RNA_def_struct(brna, "Library", "ID");
+       RNA_def_struct_ui_text(srna, "Library", "reference to an external blend file");
 
        prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
        RNA_def_property_string_sdna(prop, NULL, "name");
@@ -195,8 +201,11 @@ static void rna_def_library(BlenderRNA *brna)
 }
 void RNA_def_ID(BlenderRNA *brna)
 {
+       StructRNA *srna;
        /* simple built-in unknown type */
-       RNA_def_struct(brna, "UnknownType", NULL, "Unknown Type");
+       srna= RNA_def_struct(brna, "UnknownType", NULL);
+       RNA_def_struct_ui_text(srna, "Unknown Type", "");
+       
 
        rna_def_ID(brna);
        rna_def_ID_properties(brna);
index df67e85640257021b472229320ce5099c85a9e43..2ed0848e159a8a109e29d93caf9f2fed2d06eab3 100644 (file)
@@ -240,6 +240,11 @@ const char *RNA_struct_ui_name(PointerRNA *ptr)
        return ptr->type->name;
 }
 
+const char *RNA_struct_ui_description(PointerRNA *ptr)
+{
+       return ptr->type->description;
+}
+
 PropertyRNA *RNA_struct_name_property(PointerRNA *ptr)
 {
        return ptr->type->nameproperty;
index 90550022cc5f78200bc24fb5a4eebf6bb0bc3ae2..1848fd044121b48eb5022539733ae6a38405a70b 100644 (file)
@@ -62,7 +62,9 @@ void RNA_def_actuator(BlenderRNA *brna)
                {ACT_STATE, "STATE", "State", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Actuator", NULL , "Actuator");
+       srna= RNA_def_struct(brna, "Actuator", NULL);
+       RNA_def_struct_ui_text(srna, "Actuator", "logic brick to apply actions in the game engine");
+       
        RNA_def_struct_sdna(srna, "bActuator");
 
        prop= RNA_def_property(srna, "actuator_name", PROP_STRING, PROP_NONE);
index a29722c802bc3d2a43fe2588c03fc016aab2de6f..3c9090fbcf39bd1039dd1f0254061b89a9d9e1a1 100644 (file)
@@ -96,7 +96,8 @@ static void rna_def_bone(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "Bone", NULL, "Bone");
+       srna= RNA_def_struct(brna, "Bone", NULL);
+       RNA_def_struct_ui_text(srna, "Bone", "member of the 'Armature' type");
        
        /* pointers/collections */
                /* parent (pointer) */
@@ -251,7 +252,9 @@ void rna_def_armature(BlenderRNA *brna)
                {ARM_GHOST_KEYS, "KEYS", "On Keyframes", "Draw Ghosts of poses on Keyframes."},
                {0, NULL, NULL, NULL}};
        
-       srna= RNA_def_struct(brna, "Armature", "ID", "Armature");
+       srna= RNA_def_struct(brna, "Armature", "ID");
+       RNA_def_struct_ui_text(srna, "Armature", "'Object' containing a hierarchy of 'Bones', often used to rig characters");
+       
        RNA_def_struct_sdna(srna, "bArmature");
        
        /* Collections */
index 9b720370fccad8a4a5339f99fa2174d8672f079f..d0f4aa5a747b1ed0f726f967489e4fe442a98860 100644 (file)
@@ -50,7 +50,8 @@ void rna_def_brush(BlenderRNA *brna)
                {BRUSH_BLEND_ADD_ALPHA, "ADD_ALPHA", "Add Alpha", "Add alpha while painting."},
                {0, NULL, NULL, NULL}};
        
-       srna= RNA_def_struct(brna, "Brush", "ID", "Brush");
+       srna= RNA_def_struct(brna, "Brush", "ID");
+       RNA_def_struct_ui_text(srna, "Brush", "stores brush setting for painting in the image view, sculpting and projection painting");
        
        /* enums */
        prop= RNA_def_property(srna, "blend", PROP_ENUM, PROP_NONE);
index 55fc5989fa859ab8b32c85250d08761daeaf27fc..62de3914ee573c41760c196b6a0e5bc853d3556f 100644 (file)
@@ -48,7 +48,8 @@ void RNA_def_camera(BlenderRNA *brna)
                {CAM_ANGLETOGGLE, "DEGREES", "Degrees", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Camera", "ID", "Camera");
+       srna= RNA_def_struct(brna, "Camera", "ID");
+       RNA_def_struct_ui_text(srna, "Camera", "'Object' data where camera settings are stored and animated");
 
        /* Enums */
        prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
index c3ebf591d8187878e08f5eb5afb72272a0911c9a..97000deb5a7a8f23f9ccb2ab6f2b1d61c6c570f3 100644 (file)
@@ -121,25 +121,26 @@ static void rna_def_curvemappoint(BlenderRNA *brna)
                {0, NULL, NULL, NULL}
     };
 
-       srna= RNA_def_struct(brna, "CurveMapPoint", NULL, "CurveMapPoint");
+       srna= RNA_def_struct(brna, "CurveMapPoint", NULL);
+       RNA_def_struct_ui_text(srna, "CurveMapPoint", "member of 'CurveMap' where these points make up a curve");
 
        /* not editable for now, need to have CurveMapping to do curvemapping_changed */
 
-    prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
+       prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_float_sdna(prop, NULL, "x");
        RNA_def_property_array(prop, 2);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-    RNA_def_property_ui_text(prop, "Location", "");
+       RNA_def_property_ui_text(prop, "Location", "");
 
        prop= RNA_def_property(srna, "handle_type", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
        RNA_def_property_enum_items(prop, prop_handle_type_items);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-    RNA_def_property_ui_text(prop, "Handle Type", "");
+       RNA_def_property_ui_text(prop, "Handle Type", "");
 
-    prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
+       prop= RNA_def_property(srna, "selected", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_SELECT);
-    RNA_def_property_ui_text(prop, "Selected", "");
+       RNA_def_property_ui_text(prop, "Selected", "");
 }
 
 static void rna_def_curvemap(BlenderRNA *brna)
@@ -152,7 +153,8 @@ static void rna_def_curvemap(BlenderRNA *brna)
                {0, NULL, NULL, NULL}
     };
 
-       srna= RNA_def_struct(brna, "CurveMap", NULL, "CurveMap");
+       srna= RNA_def_struct(brna, "CurveMap", NULL);
+       RNA_def_struct_ui_text(srna, "CurveMap", "User editable curve, member of 'CurveMapping'");
 
        /* not editable for now, need to have CurveMapping to do curvemapping_changed */
 
@@ -160,48 +162,49 @@ static void rna_def_curvemap(BlenderRNA *brna)
        RNA_def_property_enum_bitflag_sdna(prop, NULL, "flag");
        RNA_def_property_enum_items(prop, prop_extend_items);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
-    RNA_def_property_ui_text(prop, "Extend", "");
+       RNA_def_property_ui_text(prop, "Extend", "");
 
-    prop= RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
+       prop= RNA_def_property(srna, "points", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_collection_sdna(prop, NULL, "curve", "totpoint");
-    RNA_def_property_struct_type(prop, "CurveMapPoint");
-    RNA_def_property_ui_text(prop, "Points", "");
+       RNA_def_property_struct_type(prop, "CurveMapPoint");
+       RNA_def_property_ui_text(prop, "Points", "");
 }
 
 static void rna_def_curvemapping(BlenderRNA *brna)
 {
        StructRNA *srna;
-    PropertyRNA *prop;
-
-       srna= RNA_def_struct(brna, "CurveMapping", NULL, "CurveMapping");
+       PropertyRNA *prop;
 
-    prop= RNA_def_property(srna, "clip", PROP_BOOLEAN, PROP_NONE);
-    RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_DO_CLIP);
-    RNA_def_property_ui_text(prop, "Clip", "");
+       srna= RNA_def_struct(brna, "CurveMapping", NULL);
+       RNA_def_struct_ui_text(srna, "CurveMapping", "Curve used to alter color or intensity of one or more inputs");
+       
+       prop= RNA_def_property(srna, "clip", PROP_BOOLEAN, PROP_NONE);
+       RNA_def_property_boolean_sdna(prop, NULL, "flag", CUMA_DO_CLIP);
+       RNA_def_property_ui_text(prop, "Clip", "");
        RNA_def_property_boolean_funcs(prop, NULL, "rna_CurveMapping_clip_set");
 
-    prop= RNA_def_property(srna, "clip_min_x", PROP_FLOAT, PROP_NONE);
-    RNA_def_property_float_sdna(prop, NULL, "clipr.xmin");
+       prop= RNA_def_property(srna, "clip_min_x", PROP_FLOAT, PROP_NONE);
+       RNA_def_property_float_sdna(prop, NULL, "clipr.xmin");
        RNA_def_property_range(prop, -100.0f, 100.0f);
-    RNA_def_property_ui_text(prop, "Clip Min X", "");
+       RNA_def_property_ui_text(prop, "Clip Min X", "");
        RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipminx_range");
 
-    prop= RNA_def_property(srna, "clip_min_y", PROP_FLOAT, PROP_NONE);
-    RNA_def_property_float_sdna(prop, NULL, "clipr.ymin");
+       prop= RNA_def_property(srna, "clip_min_y", PROP_FLOAT, PROP_NONE);
+       RNA_def_property_float_sdna(prop, NULL, "clipr.ymin");
        RNA_def_property_range(prop, -100.0f, 100.0f);
-    RNA_def_property_ui_text(prop, "Clip Min Y", "");
+       RNA_def_property_ui_text(prop, "Clip Min Y", "");
        RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipminy_range");
 
-    prop= RNA_def_property(srna, "clip_max_x", PROP_FLOAT, PROP_NONE);
-    RNA_def_property_float_sdna(prop, NULL, "clipr.xmax");
+       prop= RNA_def_property(srna, "clip_max_x", PROP_FLOAT, PROP_NONE);
+       RNA_def_property_float_sdna(prop, NULL, "clipr.xmax");
        RNA_def_property_range(prop, -100.0f, 100.0f);
-    RNA_def_property_ui_text(prop, "Clip Max X", "");
+       RNA_def_property_ui_text(prop, "Clip Max X", "");
        RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipmaxx_range");
 
-    prop= RNA_def_property(srna, "clip_max_y", PROP_FLOAT, PROP_NONE);
-    RNA_def_property_float_sdna(prop, NULL, "clipr.ymax");
+       prop= RNA_def_property(srna, "clip_max_y", PROP_FLOAT, PROP_NONE);
+       RNA_def_property_float_sdna(prop, NULL, "clipr.ymax");
        RNA_def_property_range(prop, -100.0f, 100.0f);
-    RNA_def_property_ui_text(prop, "Clip Max Y", "");
+       RNA_def_property_ui_text(prop, "Clip Max Y", "");
        RNA_def_property_float_funcs(prop, NULL, NULL, "rna_CurveMapping_clipmaxy_range");
 
        prop= RNA_def_property(srna, "curves", PROP_COLLECTION, PROP_NONE);
@@ -209,13 +212,13 @@ static void rna_def_curvemapping(BlenderRNA *brna)
        RNA_def_property_struct_type(prop, "CurveMap");
        RNA_def_property_ui_text(prop, "Curves", "");
 
-    prop= RNA_def_property(srna, "black_level", PROP_FLOAT, PROP_COLOR);
+       prop= RNA_def_property(srna, "black_level", PROP_FLOAT, PROP_COLOR);
        RNA_def_property_float_sdna(prop, NULL, "black");
        RNA_def_property_ui_range(prop, 0.0f, 1.0f, 10, 3);
        RNA_def_property_ui_text(prop, "Black Level", "");
        RNA_def_property_float_funcs(prop, NULL, "rna_CurveMapping_black_level_set", NULL);
 
-    prop= RNA_def_property(srna, "white_level", PROP_FLOAT, PROP_COLOR);
+       prop= RNA_def_property(srna, "white_level", PROP_FLOAT, PROP_COLOR);
        RNA_def_property_float_sdna(prop, NULL, "white");
        RNA_def_property_ui_range(prop, 0.0f, 1.0f, 10, 3);
        RNA_def_property_ui_text(prop, "White Level", "");
index 5e1f2ed53e3e13363843f23d5bec44038b799845..7ced246fa980efc6eb5a7c4c8d393826f3f53f0f 100644 (file)
@@ -71,7 +71,8 @@ void rna_def_constraint_basedata(BlenderRNA *brna)
                {0, NULL, NULL, NULL}};
        
        /* data */
-       srna= RNA_def_struct(brna, "Constraint", NULL , "Constraint");
+       srna= RNA_def_struct(brna, "Constraint", NULL );
+       RNA_def_struct_ui_text(srna, "Constraint", "alter the transformation of 'Objects' or 'Bones' from a number of predefined constraints");
        RNA_def_struct_sdna(srna, "bConstraint");
        
        /* strings */
index 3b52069f5567df8d6fd3ed99ab428e9c73077ad6..eb32877b6c4b2b460662998190942ae8f403729e 100644 (file)
@@ -78,7 +78,8 @@ void RNA_def_controller(BlenderRNA *brna)
                {0, NULL, NULL, NULL}};
 
        /* Controller */
-       srna= RNA_def_struct(brna, "Controller", NULL , "Controller");
+       srna= RNA_def_struct(brna, "Controller", NULL);
+       RNA_def_struct_ui_text(srna, "Controller", "logic brick to connect 'Sensors' to 'Actuators'");
        RNA_def_struct_sdna(srna, "bController");
        RNA_def_struct_funcs(srna, NULL, "rna_Controller_refine");
 
@@ -93,7 +94,8 @@ void RNA_def_controller(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Type", "");
 
        /* Expression Controller */
-       srna= RNA_def_struct(brna, "ExpressionController", "Controller", "Expression Controller");
+       srna= RNA_def_struct(brna, "ExpressionController", "Controller");
+       RNA_def_struct_ui_text(srna, "Expression Controller", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bExpressionCont", "data");
 
        prop= RNA_def_property(srna, "expression", PROP_STRING, PROP_NONE);
@@ -102,7 +104,8 @@ void RNA_def_controller(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Expression", "");
 
        /* Python Controller */
-       srna= RNA_def_struct(brna, "PythonController", "Controller" , "Python Controller");
+       srna= RNA_def_struct(brna, "PythonController", "Controller" );
+       RNA_def_struct_ui_text(srna, "Python Controller", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bPythonCont", "data");
 
        prop= RNA_def_property(srna, "text", PROP_POINTER, PROP_NONE);
@@ -110,12 +113,23 @@ void RNA_def_controller(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Python Text", "");
 
        /* Other Controllers */
-       RNA_def_struct(brna, "AndController", "Controller", "And Controller");
-       RNA_def_struct(brna, "OrController", "Controller", "Or Controller");
-       RNA_def_struct(brna, "NorController", "Controller", "Nor Controller");
-       RNA_def_struct(brna, "NandController", "Controller", "Nand Controller");
-       RNA_def_struct(brna, "XorController", "Controller", "Xor Controller");
-       RNA_def_struct(brna, "XnorController", "Controller", "Xnor Controller");
+       srna= RNA_def_struct(brna, "AndController", "Controller");
+       RNA_def_struct_ui_text(srna, "And Controller", "DOC_BROKEN");
+       
+       srna= RNA_def_struct(brna, "OrController", "Controller");
+       RNA_def_struct_ui_text(srna, "Or Controller", "DOC_BROKEN");
+       
+       srna= RNA_def_struct(brna, "NorController", "Controller");
+       RNA_def_struct_ui_text(srna, "Nor Controller", "DOC_BROKEN");
+       
+       srna= RNA_def_struct(brna, "NandController", "Controller");
+       RNA_def_struct_ui_text(srna, "Nand Controller", "DOC_BROKEN");
+       
+       srna= RNA_def_struct(brna, "XorController", "Controller");
+       RNA_def_struct_ui_text(srna, "Xor Controller", "DOC_BROKEN");
+       
+       srna= RNA_def_struct(brna, "XnorController", "Controller");
+       RNA_def_struct_ui_text(srna, "Xnor Controller", "DOC_BROKEN");
 }
 
 #endif
index ade01c9f2c2ac7361e71411abcdf14f67ab9f22c..97243de695a694f32d2a9a3fbc197de4637a1135 100644 (file)
@@ -50,8 +50,9 @@ void rna_def_curve(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "Curve", "ID", "Curve");
-
+       srna= RNA_def_struct(brna, "Curve", "ID");
+       RNA_def_struct_ui_text(srna, "Curve", "Curve Object Data for storing any number of bezier splines, nurbs or poly lines");
+       
        rna_def_ipo_common(srna);
        rna_def_texmat_common(srna, "rna_Curve_texspace_editable");
 
@@ -294,7 +295,8 @@ void rna_def_textbox(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "TextBox", NULL, "TextBox");
+       srna= RNA_def_struct(brna, "TextBox", NULL);
+       RNA_def_struct_ui_text(srna, "Text Box", "DOC_BROKEN");
        
        /* number values */
        prop= RNA_def_property(srna, "x", PROP_FLOAT, PROP_NONE);
@@ -323,7 +325,8 @@ void rna_def_charinfo(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "CharInfo", NULL, "CharInfo");
+       srna= RNA_def_struct(brna, "CharInfo", NULL);
+       RNA_def_struct_ui_text(srna, "Character Info", "DOC_BROKEN");
        
        /* flags */
        prop= RNA_def_property(srna, "style", PROP_BOOLEAN, PROP_NONE);
index 849bc9a1447bbf023053dcbe6bd110117184760a..14e4763d2c07de4d102da137b5de37ae96c82ae6 100644 (file)
@@ -319,7 +319,7 @@ static PropertyDefRNA *rna_find_def_property(StructRNA *srna, PropertyRNA *prop)
 
 /* Struct Definition */
 
-StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from, const char *name)
+StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *from)
 {
        StructRNA *srna, *srnafrom= NULL;
        StructDefRNA *ds= NULL, *dsfrom= NULL;
@@ -363,7 +363,8 @@ StructRNA *RNA_def_struct(BlenderRNA *brna, const char *identifier, const char *
        }
 
        srna->identifier= identifier;
-       srna->name= name;
+       srna->name= identifier; /* may be overwritten later RNA_def_struct_ui_text */
+       srna->description= "";
 
        rna_addtail(&brna->structs, srna);
 
@@ -532,7 +533,7 @@ void RNA_def_struct_funcs(StructRNA *srna, const char *notify, const char *refin
 }
 
 
-void RNA_def_struct_identifier(StructRNA *srna, const char *identifier, const char *name)
+void RNA_def_struct_identifier(StructRNA *srna, const char *identifier)
 {
        if(DefRNA.preprocess) {
                fprintf(stderr, "RNA_def_struct_name_runtime: only at runtime.\n");
@@ -540,7 +541,12 @@ void RNA_def_struct_identifier(StructRNA *srna, const char *identifier, const ch
        }
 
        srna->identifier= identifier;
+}
+
+void RNA_def_struct_ui_text(StructRNA *srna, const char *name, const char *description)
+{
        srna->name= name;
+       srna->description= description;
 }
 
 /* Property Definition */
index 54ac834466bce18b9dfc8dd7523bf5597bc9a223..1125482d96662dcdba89e1e51d9e36957e9af8b3 100644 (file)
@@ -48,7 +48,8 @@ void RNA_def_group(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "Group", "ID", "Group");
+       srna= RNA_def_struct(brna, "Group", "ID");
+       RNA_def_struct_ui_text(srna, "Group", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "dupli_offset", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_float_sdna(prop, NULL, "dupli_ofs");
index 07e0e2c2bd6bcaf1ba68b74bc811a6de60b7fdfc..35d0d926b0f290c5a52b285dabd66dabdc5e0b70 100644 (file)
@@ -43,7 +43,8 @@ static void rna_def_imageuser(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "ImageUser", NULL, "ImageUser");
+       srna= RNA_def_struct(brna, "ImageUser", NULL);
+       RNA_def_struct_ui_text(srna, "Image User", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "auto_refresh", PROP_BOOLEAN, PROP_NONE);
        RNA_def_property_boolean_sdna(prop, NULL, "flag", IMA_ANIM_ALWAYS);
@@ -111,7 +112,8 @@ static void rna_def_image(BlenderRNA *brna)
                {IMA_REFLECT, "REFLECTION", "Reflection", "Use reflection mapping for mapping the image"},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Image", "ID", "Image");
+       srna= RNA_def_struct(brna, "Image", "ID");
+       RNA_def_struct_ui_text(srna, "Image", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
        RNA_def_property_string_sdna(prop, NULL, "name");
index c878d33d87d94b1ab052ece01f9bfb5feeb19927..525ed536dc6aad77811bdbcb14a4f8051a763a6e 100644 (file)
@@ -214,7 +214,9 @@ struct StructRNA {
 
        /* user readable name */
        const char *name;
-
+       /* single line description, displayed in the tooltip for example */
+       const char *description;
+       
        /* property that defines the name */
        PropertyRNA *nameproperty;
 
index f04c868a1dab524dffbd6970608d113f7f370d3e..3fb0f064eae4a8a9628fcfd2cc1ec8a963cafb77 100644 (file)
@@ -44,7 +44,8 @@ void rna_def_ipodriver(BlenderRNA *brna)
                {IPO_DRIVER_TYPE_PYTHON, "SCRIPTED", "Scripted", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "IpoDriver", NULL, "Ipo Driver");
+       srna= RNA_def_struct(brna, "IpoDriver", NULL);
+       RNA_def_struct_ui_text(srna, "Ipo Driver", "DOC_BROKEN");
 
        /* Enums */
        prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
@@ -77,7 +78,8 @@ void rna_def_ipocurve(BlenderRNA *brna)
                {IPO_CYCLX, "CYCLICX", "Cyclic Extrapolation", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "IpoCurve", NULL, "Ipo Curve");
+       srna= RNA_def_struct(brna, "IpoCurve", NULL);
+       RNA_def_struct_ui_text(srna, "Ipo Curve", "DOC_BROKEN");
 
        /* Enums */
        prop= RNA_def_property(srna, "interpolation", PROP_ENUM, PROP_NONE);
@@ -119,7 +121,8 @@ void rna_def_ipo(BlenderRNA *brna)
                {ID_PA, "PARTICLES", "Particles", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Ipo", "ID", "Ipo");
+       srna= RNA_def_struct(brna, "Ipo", "ID");
+       RNA_def_struct_ui_text(srna, "Ipo", "DOC_BROKEN");
 
        /* Enums */
        prop= RNA_def_property(srna, "block_type", PROP_ENUM, PROP_NONE);
index ee0308c378204322121fa1fedf4a2e3acaf7493f..bf328388836c68282a9ec44a68c16202b47d7218 100644 (file)
@@ -200,14 +200,16 @@ static void rna_def_keydata(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "ShapeKeyPoint", NULL, "Shape Key Point");
+       srna= RNA_def_struct(brna, "ShapeKeyPoint", NULL);
+       RNA_def_struct_ui_text(srna, "Shape Key Point", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_array(prop, 3);
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyPoint_co_get", "rna_ShapeKeyPoint_co_set", NULL);
        RNA_def_property_ui_text(prop, "Location", "");
 
-       srna= RNA_def_struct(brna, "ShapeKeyCurvePoint", NULL, "Shape Key Curve Point");
+       srna= RNA_def_struct(brna, "ShapeKeyCurvePoint", NULL);
+       RNA_def_struct_ui_text(srna, "Shape Key Curve Point", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_array(prop, 3);
@@ -218,7 +220,8 @@ static void rna_def_keydata(BlenderRNA *brna)
        RNA_def_property_float_funcs(prop, "rna_ShapeKeyCurvePoint_tilt_get", "rna_ShapeKeyCurvePoint_tilt_set", NULL);
        RNA_def_property_ui_text(prop, "Tilt", "");
 
-       srna= RNA_def_struct(brna, "ShapeKeyBezierPoint", NULL, "Shape Key Bezier Point");
+       srna= RNA_def_struct(brna, "ShapeKeyBezierPoint", NULL);
+       RNA_def_struct_ui_text(srna, "Shape Key Bezier Point", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_array(prop, 3);
@@ -252,7 +255,8 @@ static void rna_def_keyblock(BlenderRNA *brna)
                {KEY_BSPLINE, "KEY_BSPLINE", "BSpline", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "ShapeKey", NULL, "Shape Key");
+       srna= RNA_def_struct(brna, "ShapeKey", NULL);
+       RNA_def_struct_ui_text(srna, "Shape Key", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "KeyBlock");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -312,7 +316,8 @@ static void rna_def_key(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "Key", "ID", "Key");
+       srna= RNA_def_struct(brna, "Key", "ID");
+       RNA_def_struct_ui_text(srna, "Key", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "reference_key", PROP_POINTER, PROP_NONE);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
index fd9067ebd247836a54d9518e3abd5794a0e2e3f7..6e7def08a63feb9149a3a5aa467804c2843ca3f3 100644 (file)
@@ -116,7 +116,8 @@ void RNA_def_lamp(BlenderRNA *brna)
                {LA_FALLOFF_SLIDERS, "SLIDERS", "Lin/Quad Weighted", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Lamp", "ID", "Lamp");
+       srna= RNA_def_struct(brna, "Lamp", "ID");
+       RNA_def_struct_ui_text(srna, "Lamp", "DOC_BROKEN");
 
        /* Enums */
        prop= RNA_def_property(srna, "type", PROP_ENUM, PROP_NONE);
index 1471d80e93847fd0ff37359eb3fef47743fdf615..c2d4a53770b43dea12df7c24c75482fdfbad4002 100644 (file)
@@ -46,7 +46,8 @@ void RNA_def_lattice(BlenderRNA *brna)
                {KEY_BSPLINE, "KEY_BSPLINE", "BSpline", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Lattice", "ID", "Lattice");
+       srna= RNA_def_struct(brna, "Lattice", "ID");
+       RNA_def_struct_ui_text(srna, "Lattice", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "points_u", PROP_INT, PROP_NONE);
        RNA_def_property_int_sdna(prop, NULL, "pntsu");
index b2ee9f4e12f4e09d055485b208bb6282d11bfb28..cf6ebce2db63aa1b09a63de931e8ffaccf6cfbdc 100644 (file)
@@ -251,7 +251,8 @@ void RNA_def_main(BlenderRNA *brna)
                {NULL, NULL, NULL, NULL, NULL}};
        int i;
        
-       srna= RNA_def_struct(brna, "Main", NULL, "Main");
+       srna= RNA_def_struct(brna, "Main", NULL);
+       RNA_def_struct_ui_text(srna, "Main", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
        RNA_def_property_string_maxlength(prop, 240);
index 3b91bd92c6b9fd2c60f85b4bae4369b5cbd034be..acd122db8c553ccce5c31896e94eca457571d6a0 100644 (file)
@@ -60,7 +60,8 @@ void RNA_def_material(BlenderRNA *brna)
                {0, NULL, NULL, NULL}};
        
        
-       srna= RNA_def_struct(brna, "Material", "ID", "Material");
+       srna= RNA_def_struct(brna, "Material", "ID");
+       RNA_def_struct_ui_text(srna, "Material", "DOC_BROKEN");
                
        prop= RNA_def_property(srna, "color_model", PROP_ENUM, PROP_NONE);
        RNA_def_property_enum_sdna(prop, NULL, "colormodel");
index cb17ec1a1efec7adfd04e5b913e82ef96ed59d73..d5489cede98baf1c4a689501e1240802438d7230 100644 (file)
@@ -441,7 +441,8 @@ static void rna_def_mvert_group(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MVertGroup", NULL, "Mesh Vertex Group");
+       srna= RNA_def_struct(brna, "MVertGroup", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Vertex Group", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "MDeformWeight");
 
        /* we can't point to actual group, it is in the object and so
@@ -461,7 +462,8 @@ static void rna_def_mvert(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MVert", NULL, "Mesh Vertex");
+       srna= RNA_def_struct(brna, "MVert", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Vertex", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_ui_text(prop, "Location", "");
@@ -494,7 +496,8 @@ static void rna_def_medge(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MEdge", NULL, "Mesh Edge");
+       srna= RNA_def_struct(brna, "MEdge", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Edge", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "verts", PROP_INT, PROP_UNSIGNED);
        RNA_def_property_int_sdna(prop, NULL, "v1");
@@ -532,7 +535,8 @@ static void rna_def_mface(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MFace", NULL, "Mesh Face");
+       srna= RNA_def_struct(brna, "MFace", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Face", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "verts", PROP_INT, PROP_UNSIGNED);
        RNA_def_property_int_sdna(prop, NULL, "v1");
@@ -570,7 +574,8 @@ static void rna_def_mtface(BlenderRNA *brna)
                {TF_CLIP, "CLIPALPHA", "Clip Alpha", "Use the images alpha values clipped with no blending (binary alpha)"},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "MTFace", NULL, "Mesh Texture Face");
+       srna= RNA_def_struct(brna, "MTFace", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Texture Face", "DOC_BROKEN");
 
        /* prop= RNA_def_property(srna, "image", PROP_POINTER, PROP_NONE);
        RNA_def_property_pointer_sdna(prop, NULL, "tpage");
@@ -662,7 +667,8 @@ static void rna_def_mtface(BlenderRNA *brna)
        RNA_def_property_float_funcs(prop, "rna_MTFace_uv4_get", "rna_MTFace_uv4_set", NULL);
        RNA_def_property_ui_text(prop, "UV 4", "");
 
-       srna= RNA_def_struct(brna, "MTFaceLayer", NULL, "Mesh Texture Face Layer");
+       srna= RNA_def_struct(brna, "MTFaceLayer", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Texture Face Layer", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "CustomDataLayer");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -689,7 +695,8 @@ static void rna_def_msticky(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MSticky", NULL, "Mesh Vertex Sticky Texture Coordinate");
+       srna= RNA_def_struct(brna, "MSticky", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Vertex Sticky Texture Coordinate", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "co", PROP_FLOAT, PROP_VECTOR);
        RNA_def_property_ui_text(prop, "Location", "Sticky texture coordinate location");
@@ -700,7 +707,8 @@ static void rna_def_mcol(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MCol", NULL, "Mesh Vertex Color");
+       srna= RNA_def_struct(brna, "MCol", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Vertex Color", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "color1", PROP_FLOAT, PROP_COLOR);
        RNA_def_property_array(prop, 3);
@@ -722,7 +730,8 @@ static void rna_def_mcol(BlenderRNA *brna)
        RNA_def_property_float_funcs(prop, "rna_MCol_color4_get", "rna_MCol_color4_set", NULL);
        RNA_def_property_ui_text(prop, "Color 4", "");
 
-       srna= RNA_def_struct(brna, "MColLayer", NULL, "Mesh Vertex Color Layer");
+       srna= RNA_def_struct(brna, "MColLayer", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Vertex Color Layer", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "CustomDataLayer");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -750,13 +759,15 @@ static void rna_def_mproperties(BlenderRNA *brna)
        PropertyRNA *prop;
 
        /* Float */
-       srna= RNA_def_struct(brna, "MFloatProperty", NULL, "Mesh Float Property");
+       srna= RNA_def_struct(brna, "MFloatProperty", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Float Property", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
        RNA_def_property_float_sdna(prop, NULL, "f");
        RNA_def_property_ui_text(prop, "Value", "");
 
-       srna= RNA_def_struct(brna, "MFloatPropertyLayer", NULL, "Mesh Float Property Layer");
+       srna= RNA_def_struct(brna, "MFloatPropertyLayer", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Float Property Layer", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "CustomDataLayer");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -769,13 +780,15 @@ static void rna_def_mproperties(BlenderRNA *brna)
        RNA_def_property_collection_funcs(prop, "rna_MFloatPropertyLayer_data_begin", "rna_iterator_array_next", "rna_iterator_array_end", "rna_iterator_array_get", 0, "rna_MFloatPropertyLayer_data_length", 0, 0);
 
        /* Int */
-       srna= RNA_def_struct(brna, "MIntProperty", NULL, "Mesh Int Property");
+       srna= RNA_def_struct(brna, "MIntProperty", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Int Property", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "value", PROP_INT, PROP_NONE);
        RNA_def_property_int_sdna(prop, NULL, "i");
        RNA_def_property_ui_text(prop, "Value", "");
 
-       srna= RNA_def_struct(brna, "MIntPropertyLayer", NULL, "Mesh Int Property Layer");
+       srna= RNA_def_struct(brna, "MIntPropertyLayer", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Int Property Layer", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "CustomDataLayer");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -788,13 +801,15 @@ static void rna_def_mproperties(BlenderRNA *brna)
        RNA_def_property_collection_funcs(prop, "rna_MIntPropertyLayer_data_begin", "rna_iterator_array_next", "rna_iterator_array_end", "rna_iterator_array_get", 0, "rna_MIntPropertyLayer_data_length", 0, 0);
 
        /* String */
-       srna= RNA_def_struct(brna, "MStringProperty", NULL, "Mesh String Property");
+       srna= RNA_def_struct(brna, "MStringProperty", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh String Property", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
        RNA_def_property_string_sdna(prop, NULL, "s");
        RNA_def_property_ui_text(prop, "Value", "");
 
-       srna= RNA_def_struct(brna, "MStringPropertyLayer", NULL, "Mesh String Property Layer");
+       srna= RNA_def_struct(brna, "MStringPropertyLayer", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh String Property Layer", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "CustomDataLayer");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -812,7 +827,8 @@ static void rna_def_mmultires(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MMultires", NULL, "Mesh Multires");
+       srna= RNA_def_struct(brna, "MMultires", NULL);
+       RNA_def_struct_ui_text(srna, "Mesh Multires", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Multires");
 
        prop= RNA_def_property(srna, "level", PROP_INT, PROP_NONE);
@@ -881,7 +897,8 @@ static void rna_def_mesh(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "Mesh", "ID", "Mesh");
+       srna= RNA_def_struct(brna, "Mesh", "ID");
+       RNA_def_struct_ui_text(srna, "Mesh", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "verts", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_collection_sdna(prop, NULL, "mvert", "totvert");
index 9b88c80d0d4290b59f55af53de8c2a6c1dbb642c..043f99326227a4ff43c866f5c7427c17314a834f 100644 (file)
@@ -53,7 +53,8 @@ void rna_def_metaelement(BlenderRNA *brna)
                {MB_CUBE, "CUBE", "Cube", ""},
                {0, NULL, NULL, NULL}};
        
-       srna= RNA_def_struct(brna, "MetaElement", NULL, "Meta Element");
+       srna= RNA_def_struct(brna, "MetaElement", NULL);
+       RNA_def_struct_ui_text(srna, "Meta Element", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "MetaElem");
        
        /* enums */
@@ -108,7 +109,8 @@ void rna_def_metaball(BlenderRNA *brna)
                {MB_UPDATE_NEVER, "NEVER", "Never", "While editing, don't update metaball at all."},
                {0, NULL, NULL, NULL}};
        
-       srna= RNA_def_struct(brna, "MetaBall", "ID", "MetaBall");
+       srna= RNA_def_struct(brna, "MetaBall", "ID");
+       RNA_def_struct_ui_text(srna, "MetaBall", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "elements", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_collection_sdna(prop, NULL, "elems", NULL);
index c3a2274101f6fb2f694b719344cd90263c9dd4a6..a24c25880c9cfa8bd86eef55337a35c8d725b443 100644 (file)
@@ -72,7 +72,8 @@ void RNA_def_modifier(BlenderRNA *brna)
                {0, NULL, NULL, NULL}};
        
        /* data */
-       srna= RNA_def_struct(brna, "Modifier", NULL , "Object Modifier");
+       srna= RNA_def_struct(brna, "Modifier", NULL);
+       RNA_def_struct_ui_text(srna , "Object Modifier", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "ModifierData");
        
        /* strings */
index a4b13b7639b32609038383932ef3802ad9ef6cd9..5c6d32eb781cf3ba3d83983a1e5061fd638aed31 100644 (file)
@@ -40,7 +40,8 @@ void RNA_def_nodetree(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "NodeTree", "ID", "Node Tree");
+       srna= RNA_def_struct(brna, "NodeTree", "ID");
+       RNA_def_struct_ui_text(srna, "Node Tree", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bNodeTree");
 
        prop= RNA_def_property(srna, "Nodes", PROP_COLLECTION, PROP_NONE);
@@ -49,7 +50,8 @@ void RNA_def_nodetree(BlenderRNA *brna)
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
        RNA_def_property_ui_text(prop, "Nodes", "");
        
-       srna= RNA_def_struct(brna, "Node", NULL, "Node");
+       srna= RNA_def_struct(brna, "Node", NULL);
+       RNA_def_struct_ui_text(srna, "Node", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bNode");
        
        prop= RNA_def_property(srna, "location", PROP_FLOAT, PROP_VECTOR);
index 430ae57d87a42c04fceb98afc5a9eec068dec645..e49227305f10cb13458837f39dbf33ca5c348236 100644 (file)
@@ -42,7 +42,8 @@ void RNA_def_object(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "Object", "ID", "Object");
+       srna= RNA_def_struct(brna, "Object", "ID");
+       RNA_def_struct_ui_text(srna, "Object", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "data", PROP_POINTER, PROP_NONE);
        RNA_def_property_struct_type(prop, "ID");
index 0bbdd5bfd8c6ba8fddbd8fa92e722b8dbab672eb..76095ac9923c9a51312597fde5f428c8b5cb90cc 100644 (file)
@@ -39,7 +39,8 @@ void RNA_def_packedfile(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "PackedFile", NULL, "Packed File");
+       srna= RNA_def_struct(brna, "PackedFile", NULL);
+       RNA_def_struct_ui_text(srna, "Packed File", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "size", PROP_INT, PROP_NONE);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
index 626bf0bf43d4be68c27160aeb107034762fb86e4..9f42d398bb0fe1f2d669850ce2ebfe775b902e1a 100644 (file)
@@ -84,7 +84,8 @@ void RNA_def_gameproperty(BlenderRNA *brna)
                {0, NULL, NULL, NULL}};
 
        /* Base Struct for GameProperty */
-       srna= RNA_def_struct(brna, "GameProperty", NULL , "Game Property");
+       srna= RNA_def_struct(brna, "GameProperty", NULL);
+       RNA_def_struct_ui_text(srna , "Game Property", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bProperty");
        RNA_def_struct_funcs(srna, NULL, "rna_GameProperty_refine");
 
@@ -103,7 +104,8 @@ void RNA_def_gameproperty(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Debug", "Print debug information for this property.");
 
        /* GameBooleanProperty */
-       srna= RNA_def_struct(brna, "GameBooleanProperty", "GameProperty" , "Game Boolean Property");
+       srna= RNA_def_struct(brna, "GameBooleanProperty", "GameProperty");
+       RNA_def_struct_ui_text(srna , "Game Boolean Property", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bProperty");
 
        prop= RNA_def_property(srna, "boolean_value", PROP_BOOLEAN, PROP_NONE);
@@ -111,7 +113,8 @@ void RNA_def_gameproperty(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Value", "Property value.");
 
        /* GameIntProperty */
-       srna= RNA_def_struct(brna, "GameIntProperty", "GameProperty" , "Game Integer Property");
+       srna= RNA_def_struct(brna, "GameIntProperty", "GameProperty");
+       RNA_def_struct_ui_text(srna , "Game Integer Property", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bProperty");
 
        prop= RNA_def_property(srna, "value", PROP_INT, PROP_NONE);
@@ -120,7 +123,8 @@ void RNA_def_gameproperty(BlenderRNA *brna)
        RNA_def_property_range(prop, -10000, 10000);
 
        /* GameFloatProperty */
-       srna= RNA_def_struct(brna, "GameFloatProperty", "GameProperty" , "Game Float Property");
+       srna= RNA_def_struct(brna, "GameFloatProperty", "GameProperty");
+       RNA_def_struct_ui_text(srna, "Game Float Property", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bProperty");
 
        prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
@@ -130,7 +134,8 @@ void RNA_def_gameproperty(BlenderRNA *brna)
        RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
 
        /* GameTimerProperty */
-       srna= RNA_def_struct(brna, "GameTimeProperty", "GameProperty" , "Game Time Property");
+       srna= RNA_def_struct(brna, "GameTimeProperty", "GameProperty");
+       RNA_def_struct_ui_text(srna, "Game Time Property", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bProperty");
 
        prop= RNA_def_property(srna, "value", PROP_FLOAT, PROP_NONE);
@@ -140,7 +145,8 @@ void RNA_def_gameproperty(BlenderRNA *brna)
        RNA_def_property_float_funcs(prop, "rna_GameFloatProperty_value_get", "rna_GameFloatProperty_value_set", NULL);
 
        /* GameStringProperty */
-       srna= RNA_def_struct(brna, "GameStringProperty", "GameProperty" , "Game String Property");
+       srna= RNA_def_struct(brna, "GameStringProperty", "GameProperty");
+       RNA_def_struct_ui_text(srna, "Game String Property", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bProperty");
 
        prop= RNA_def_property(srna, "value", PROP_STRING, PROP_NONE);
index 31398b5fa4e49edc955b001f7b366fee83142135..b8f971ad55c55842cb3c765c2ce3c4d96dd221b8 100644 (file)
@@ -45,7 +45,8 @@ void RNA_def_radio(BlenderRNA *brna)
                {RAD_GOURAUD, "GOURAUD", "Gouraud", "Enables Gouraud draw mode"},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Radiosity", NULL, "Radiosity");
+       srna= RNA_def_struct(brna, "Radiosity", NULL);
+       RNA_def_struct_ui_text(srna, "Radiosity", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Radio");
 
        /* Enums */
index 7f5a78b930301dbbc444f78a75f1e004d9fcd43b..986c33051f86b104d583fe9edf8d32106a4dede7 100644 (file)
@@ -42,6 +42,16 @@ static int rna_Struct_identifier_length(PointerRNA *ptr)
        return strlen(((StructRNA*)ptr->data)->identifier);
 }
 
+static void rna_Struct_description_get(PointerRNA *ptr, char *value)
+{
+       strcpy(value, ((StructRNA*)ptr->data)->description);
+}
+
+static int rna_Struct_description_length(PointerRNA *ptr)
+{
+       return strlen(((StructRNA*)ptr->data)->description);
+}
+
 static void rna_Struct_name_get(PointerRNA *ptr, char *value)
 {
        strcpy(value, ((StructRNA*)ptr->data)->name);
@@ -232,6 +242,12 @@ static int rna_Property_subtype_get(PointerRNA *ptr)
        return prop->subtype;
 }
 
+static int rna_Property_readonly_get(PointerRNA *ptr)
+{
+       PropertyRNA *prop= (PropertyRNA*)ptr->data;
+       return RNA_property_editable(ptr, prop) ? 0 : 1;
+}
+
 static int rna_Property_array_length_get(PointerRNA *ptr)
 {
        PropertyRNA *prop= (PropertyRNA*)ptr->data;
@@ -387,7 +403,8 @@ static void rna_def_struct(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "Struct", NULL, "Struct Definition");
+       srna= RNA_def_struct(brna, "Struct", NULL);
+       RNA_def_struct_ui_text(srna, "Struct Definition", "RNA Structure definition");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
@@ -400,6 +417,11 @@ static void rna_def_struct(BlenderRNA *brna)
        RNA_def_property_ui_text(prop, "Identifier", "Unique name used in the code and scripting.");
        RNA_def_struct_name_property(srna, prop);
        
+       prop= RNA_def_property(srna, "description", PROP_STRING, PROP_NONE);
+       RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+       RNA_def_property_string_funcs(prop, "rna_Struct_description_get", "rna_Struct_description_length", NULL);
+       RNA_def_property_ui_text(prop, "description", "This field explains the Struct's purpose");
+       
        prop= RNA_def_property(srna, "base", PROP_POINTER, PROP_NONE);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
        RNA_def_property_struct_type(prop, "Struct");
@@ -443,7 +465,8 @@ static void rna_def_property(BlenderRNA *brna)
                {PROP_ROTATION, "ROTATION", "Rotation", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Property", NULL, "Property Definition");
+       srna= RNA_def_struct(brna, "Property", NULL);
+       RNA_def_struct_ui_text(srna, "Property Definition", "DOC_BROKEN2");
        RNA_def_struct_funcs(srna, NULL, "rna_Property_refine");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -473,6 +496,11 @@ static void rna_def_property(BlenderRNA *brna)
        RNA_def_property_enum_items(prop, subtype_items);
        RNA_def_property_enum_funcs(prop, "rna_Property_subtype_get", NULL);
        RNA_def_property_ui_text(prop, "Subtype", "Semantic interpretation of the property.");
+       
+       prop= RNA_def_property(srna, "readonly", PROP_INT, PROP_NONE);
+       RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
+       RNA_def_property_int_funcs(prop, "rna_Property_readonly_get", NULL, NULL);
+       RNA_def_property_ui_text(prop, "Read Only", "Read Only setting for this property");
 }
 
 static void rna_def_number_property(StructRNA *srna, PropertyType type)
@@ -545,7 +573,8 @@ static void rna_def_enum_property(BlenderRNA *brna, StructRNA *srna)
        RNA_def_property_collection_funcs(prop, "rna_EnumProperty_items_begin", "rna_iterator_array_next", "rna_iterator_array_end", "rna_iterator_array_get", 0, 0, 0, 0);
        RNA_def_property_ui_text(prop, "Items", "Possible values for the property.");
 
-       srna= RNA_def_struct(brna, "EnumPropertyItem", NULL, "Enum Item Definition");
+       srna= RNA_def_struct(brna, "EnumPropertyItem", NULL);
+       RNA_def_struct_ui_text(srna, "Enum Item Definition", "DOC_BROKEN3");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
@@ -590,35 +619,43 @@ void RNA_def_rna(BlenderRNA *brna)
        rna_def_property(brna);
 
        /* BooleanProperty */
-       srna= RNA_def_struct(brna, "BooleanProperty", "Property", "Boolean Definition");
+       srna= RNA_def_struct(brna, "BooleanProperty", "Property");
+       RNA_def_struct_ui_text(srna, "Boolean Definition", "DOC_BROKEN4");
        rna_def_number_property(srna, PROP_BOOLEAN);
 
        /* IntProperty */
-       srna= RNA_def_struct(brna, "IntProperty", "Property", "Int Definition");
+       srna= RNA_def_struct(brna, "IntProperty", "Property");
+       RNA_def_struct_ui_text(srna, "Int Definition", "DOC_BROKEN5");
        rna_def_number_property(srna, PROP_INT);
 
        /* FloatProperty */
-       srna= RNA_def_struct(brna, "FloatProperty", "Property", "Float Definition");
+       srna= RNA_def_struct(brna, "FloatProperty", "Property");
+       RNA_def_struct_ui_text(srna, "Float Definition", "DOC_BROKEN6");
        rna_def_number_property(srna, PROP_FLOAT);
 
        /* StringProperty */
-       srna= RNA_def_struct(brna, "StringProperty", "Property", "String Definition");
+       srna= RNA_def_struct(brna, "StringProperty", "Property");
+       RNA_def_struct_ui_text(srna, "String Definition", "DOC_BROKEN7");
        rna_def_string_property(srna);
 
        /* EnumProperty */
-       srna= RNA_def_struct(brna, "EnumProperty", "Property", "Enum Definition");
+       srna= RNA_def_struct(brna, "EnumProperty", "Property");
+       RNA_def_struct_ui_text(srna, "Enum Definition", "DOC_BROKEN8");
        rna_def_enum_property(brna, srna);
 
        /* PointerProperty */
-       srna= RNA_def_struct(brna, "PointerProperty", "Property", "Pointer Definition");
+       srna= RNA_def_struct(brna, "PointerProperty", "Property");
+       RNA_def_struct_ui_text(srna, "Pointer Definition", "DOC_BROKEN9");
        rna_def_pointer_property(srna, PROP_POINTER);
 
        /* CollectionProperty */
-       srna= RNA_def_struct(brna, "CollectionProperty", "Property", "Collection Definition");
+       srna= RNA_def_struct(brna, "CollectionProperty", "Property");
+       RNA_def_struct_ui_text(srna, "Collection Definition", "DOC_BROKEN10");
        rna_def_pointer_property(srna, PROP_COLLECTION);
 
        /* Blender RNA */
-       srna= RNA_def_struct(brna, "BlenderRNA", NULL, "Blender RNA");
+       srna= RNA_def_struct(brna, "BlenderRNA", NULL);
+       RNA_def_struct_ui_text(srna, "Blender RNA", "RNA Structures");
 
        prop= RNA_def_property(srna, "structs", PROP_COLLECTION, PROP_NONE);
        RNA_def_property_flag(prop, PROP_NOT_EDITABLE);
index c6c4b710d72edcc5723dbe8782fcc41fb04bce0b..dc2eff673ec4cfd2ae89af5bff25fb2927df4a46 100644 (file)
@@ -89,7 +89,8 @@ void RNA_def_scene(BlenderRNA *brna)
                {1, "ANGLEBASED", "Angle Based", ""}, 
                {0, NULL, NULL, NULL}};
        
-       srna= RNA_def_struct(brna, "Scene", "ID", "Scene");
+       srna= RNA_def_struct(brna, "Scene", "ID");
+       RNA_def_struct_ui_text(srna, "Scene", "DOC_BROKEN");
 
        prop= RNA_def_property(srna, "camera", PROP_POINTER, PROP_NONE);
        RNA_def_property_ui_text(prop, "Active Camera", "Active camera used for rendering the scene.");
index ea62458654a4ed4096fc1894c31ea285ad0e5440..6bc85f7e6c3097d3f85315434c9b454024f31652 100644 (file)
@@ -65,7 +65,8 @@ static void RNA_def_vectypes(BlenderRNA *brna)
 {
        StructRNA *srna;
        
-       srna= RNA_def_struct(brna, "vec2s", NULL, "vec2s");
+       srna= RNA_def_struct(brna, "vec2s", NULL);
+       RNA_def_struct_ui_text(srna, "vec2s", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "vec2s");     
 }
 
@@ -74,7 +75,8 @@ static void RNA_def_scrvert(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "ScrVert", NULL, "Screen Vertex");
+       srna= RNA_def_struct(brna, "ScrVert", NULL);
+       RNA_def_struct_ui_text(srna, "Screen Vertex", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "ScrVert");
        
        prop= RNA_def_property(srna, "Location", PROP_INT, PROP_VECTOR);
@@ -89,7 +91,8 @@ static void RNA_def_scredge(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "ScrEdge", NULL, "Screen Edge");
+       srna= RNA_def_struct(brna, "ScrEdge", NULL);
+       RNA_def_struct_ui_text(srna, "Screen Edge", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "ScrEdge");
        
        prop= RNA_def_property(srna, "start", PROP_INT, PROP_VECTOR);
@@ -110,7 +113,8 @@ static void RNA_def_scrarea(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "ScrArea", NULL, "Area");
+       srna= RNA_def_struct(brna, "ScrArea", NULL);
+       RNA_def_struct_ui_text(srna, "Area", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "ScrArea");
        
        prop= RNA_def_property(srna, "v1", PROP_INT, PROP_VECTOR);
@@ -142,7 +146,8 @@ static void RNA_def_panel(BlenderRNA *brna)
 {
        StructRNA *srna;
        
-       srna= RNA_def_struct(brna, "Panel", NULL, "Panel");
+       srna= RNA_def_struct(brna, "Panel", NULL);
+       RNA_def_struct_ui_text(srna, "Panel", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Panel");
 }
 
@@ -150,7 +155,8 @@ static void RNA_def_region(BlenderRNA *brna)
 {
        StructRNA *srna;
        
-       srna= RNA_def_struct(brna, "Region", NULL, "Area Region");
+       srna= RNA_def_struct(brna, "Region", NULL);
+       RNA_def_struct_ui_text(srna, "Area Region", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "ARegion");
 }
 
@@ -159,7 +165,8 @@ static void RNA_def_bscreen(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "Screen", "ID", "Screen");
+       srna= RNA_def_struct(brna, "Screen", "ID");
+       RNA_def_struct_ui_text(srna, "Screen", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bScreen");
        
        prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
index 30e32338db7d99bfa2164b0f255a18dd2282419c..5d5999dfc86b57ab297f0fa30c46419ca6d82c1e 100644 (file)
@@ -95,7 +95,8 @@ void rna_def_sensor(BlenderRNA *brna)
                {SENS_DELAY, "DELAY", "Delay", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "Sensor", NULL, "Sensor");
+       srna= RNA_def_struct(brna, "Sensor", NULL);
+       RNA_def_struct_ui_text(srna, "Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "bSensor");
        RNA_def_struct_funcs(srna, NULL, "rna_Sensor_refine");
 
@@ -130,7 +131,9 @@ void rna_def_sensor(BlenderRNA *brna)
 
 void rna_def_always_sensor(BlenderRNA *brna)
 {
-       RNA_def_struct(brna, "AlwaysSensor", "Sensor", "Always Sensor");
+       StructRNA *srna;
+       srna= RNA_def_struct(brna, "AlwaysSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Always Sensor", "DOC_BROKEN");
 }
 
 void rna_def_near_sensor(BlenderRNA *brna)
@@ -138,7 +141,8 @@ void rna_def_near_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "NearSensor", "Sensor" , "Near Sensor");
+       srna= RNA_def_struct(brna, "NearSensor", "Sensor");
+       RNA_def_struct_ui_text(srna , "Near Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bNearSensor", "data");
 
        prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
@@ -172,7 +176,8 @@ void rna_def_mouse_sensor(BlenderRNA *brna)
                {BL_SENS_MOUSE_MOUSEOVER_ANY, "MOUSEOVERANY", "Mouse Over Any", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "MouseSensor", "Sensor", "Mouse Sensor");
+       srna= RNA_def_struct(brna, "MouseSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Mouse Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bMouseSensor", "data");
 
        prop= RNA_def_property(srna, "mouse_event", PROP_ENUM, PROP_NONE);
@@ -186,7 +191,8 @@ void rna_def_touch_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "TouchSensor", "Sensor", "Touch Sensor");
+       srna= RNA_def_struct(brna, "TouchSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Touch Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bTouchSensor", "data");
 
        prop= RNA_def_property(srna, "material", PROP_POINTER, PROP_NONE);
@@ -199,7 +205,8 @@ void rna_def_keyboard_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "KeyboardSensor", "Sensor", "Keyboard Sensor");
+       srna= RNA_def_struct(brna, "KeyboardSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Keyboard Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bKeyboardSensor", "data");
 
        prop= RNA_def_property(srna, "key", PROP_INT, PROP_NONE);
@@ -244,7 +251,8 @@ void rna_def_property_sensor(BlenderRNA *brna)
                /* {SENS_PROP_EXPRESSION, "PROPEXPRESSION", "Expression", ""},  NOT_USED_IN_UI */
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "PropertySensor", "Sensor", "Property Sensor");
+       srna= RNA_def_struct(brna, "PropertySensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Property Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bPropertySensor", "data");
 
        prop= RNA_def_property(srna, "evaluation_type", PROP_ENUM, PROP_NONE);
@@ -274,7 +282,8 @@ void rna_def_actuator_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "ActuatorSensor", "Sensor", "Actuator Sensor");
+       srna= RNA_def_struct(brna, "ActuatorSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Actuator Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bActuatorSensor", "data");
 
        prop= RNA_def_property(srna, "actuator", PROP_STRING, PROP_NONE);
@@ -287,7 +296,8 @@ void rna_def_delay_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "DelaySensor", "Sensor", "Delay Sensor");
+       srna= RNA_def_struct(brna, "DelaySensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Delay Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bDelaySensor", "data");
 
        prop= RNA_def_property(srna, "delay", PROP_INT, PROP_NONE);
@@ -312,7 +322,8 @@ void rna_def_collision_sensor(BlenderRNA *brna)
                {1, "MATERIAL", "Material", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "CollisionSensor", "Sensor", "Collision Sensor");
+       srna= RNA_def_struct(brna, "CollisionSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Collision Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bCollisionSensor", "data");
 
        prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
@@ -342,7 +353,8 @@ void rna_def_radar_sensor(BlenderRNA *brna)
                {SENS_RAY_NEG_Z_AXIS, "NEGZAXIS", "-Z axis", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "RadarSensor", "Sensor", "Radar Sensor");
+       srna= RNA_def_struct(brna, "RadarSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Radar Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bRadarSensor", "data");
 
        prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
@@ -368,7 +380,8 @@ void rna_def_random_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "RandomSensor", "Sensor", "Random Sensor");
+       srna= RNA_def_struct(brna, "RandomSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Random Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bRandomSensor", "data");
 
        prop= RNA_def_property(srna, "seed", PROP_INT, PROP_NONE);
@@ -393,7 +406,8 @@ void rna_def_ray_sensor(BlenderRNA *brna)
                {1, "MATERIAL", "Material", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "RaySensor", "Sensor", "Ray Sensor");
+       srna= RNA_def_struct(brna, "RaySensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Ray Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bRaySensor", "data");
 
        prop= RNA_def_property(srna, "property", PROP_STRING, PROP_NONE);
@@ -428,7 +442,8 @@ void rna_def_message_sensor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "MessageSensor", "Sensor", "Message Sensor");
+       srna= RNA_def_struct(brna, "MessageSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Message Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bMessageSensor", "data");
 
        prop= RNA_def_property(srna, "subject", PROP_STRING, PROP_NONE);
@@ -453,7 +468,8 @@ void rna_def_joystick_sensor(BlenderRNA *brna)
                {SENS_JOY_NEG_Y_AXIS, "DOWNAXIS", "Down Axis", ""},
                {0, NULL, NULL, NULL}};
 
-       srna= RNA_def_struct(brna, "JoystickSensor", "Sensor", "Joystick Sensor");
+       srna= RNA_def_struct(brna, "JoystickSensor", "Sensor");
+       RNA_def_struct_ui_text(srna, "Joystick Sensor", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "bJoystickSensor", "data");
        
        prop= RNA_def_property(srna, "joystick_index", PROP_INT, PROP_NONE);
index cccf54c518c6bea9ab85f6d9000a5d36249d53a3..51958563c801670e364ba3dd246f964340558f0f 100644 (file)
@@ -113,7 +113,8 @@ static void rna_def_strip_element(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SequenceElement", NULL, "Sequence Element");
+       srna = RNA_def_struct(brna, "SequenceElement", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence Element", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "StripElem");
        
        prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
@@ -126,7 +127,8 @@ static void rna_def_strip_crop(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SequenceCrop", NULL, "Sequence Crop");
+       srna = RNA_def_struct(brna, "SequenceCrop", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence Crop", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "StripCrop");
 
        prop= RNA_def_property(srna, "top", PROP_INT, PROP_UNSIGNED);
@@ -151,7 +153,8 @@ static void rna_def_strip_transform(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SequenceTransform", NULL, "Sequence Transform");
+       srna = RNA_def_struct(brna, "SequenceTransform", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence Transform", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "StripTransform");
 
        prop= RNA_def_property(srna, "offset_x", PROP_INT, PROP_NONE);
@@ -170,7 +173,8 @@ static void rna_def_strip_proxy(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SequenceProxy", NULL, "Sequence Proxy");
+       srna = RNA_def_struct(brna, "SequenceProxy", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence Proxy", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "StripProxy");
        
        prop= RNA_def_property(srna, "directory", PROP_STRING, PROP_DIRPATH);
@@ -183,7 +187,8 @@ static void rna_def_strip_color_balance(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna = RNA_def_struct(brna, "SequenceColorBalance", NULL, "Sequence Color Balance");
+       srna = RNA_def_struct(brna, "SequenceColorBalance", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence Color Balance", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "StripColorBalance");
 
        prop= RNA_def_property(srna, "lift", PROP_FLOAT, PROP_COLOR);
@@ -270,7 +275,8 @@ static void rna_def_sequence(BlenderRNA *brna)
                {0, NULL, NULL, NULL}
        };
        
-       srna = RNA_def_struct(brna, "Sequence", NULL, "Sequence");
+       srna = RNA_def_struct(brna, "Sequence", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence", "DOC_BROKEN");
        RNA_def_struct_funcs(srna, NULL, "rna_Sequence_refine");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -372,7 +378,8 @@ void rna_def_editor(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SequenceEditor", NULL, "Sequence Editor");
+       srna = RNA_def_struct(brna, "SequenceEditor", NULL);
+       RNA_def_struct_ui_text(srna, "Sequence Editor", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Editing");
 
        prop= RNA_def_property(srna, "sequences", PROP_COLLECTION, PROP_NONE);
@@ -505,7 +512,8 @@ static void rna_def_image(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "ImageSequence", "Sequence", "Image Sequence");
+       srna = RNA_def_struct(brna, "ImageSequence", "Sequence");
+       RNA_def_struct_ui_text(srna, "Image Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Sequence");
 
        prop= RNA_def_property(srna, "directory", PROP_STRING, PROP_DIRPATH);
@@ -528,7 +536,8 @@ static void rna_def_meta(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "MetaSequence", "Sequence", "Meta Sequence");
+       srna = RNA_def_struct(brna, "MetaSequence", "Sequence");
+       RNA_def_struct_ui_text(srna, "Meta Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Sequence");
 
        prop = RNA_def_property(srna, "sequences", PROP_COLLECTION, PROP_NONE);
@@ -546,7 +555,8 @@ static void rna_def_scene(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SceneSequence", "Sequence", "Scene Sequence");
+       srna = RNA_def_struct(brna, "SceneSequence", "Sequence");
+       RNA_def_struct_ui_text(srna, "Scene Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Sequence");
 
        prop= RNA_def_property(srna, "scene", PROP_POINTER, PROP_NONE);
@@ -562,7 +572,8 @@ static void rna_def_movie(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "MovieSequence", "Sequence", "Movie Sequence");
+       srna = RNA_def_struct(brna, "MovieSequence", "Sequence");
+       RNA_def_struct_ui_text(srna, "Movie Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Sequence");
 
        prop= RNA_def_property(srna, "mpeg_preseek", PROP_INT, PROP_NONE);
@@ -588,7 +599,8 @@ static void rna_def_sound(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "SoundSequence", "Sequence", "Sound Sequence");
+       srna = RNA_def_struct(brna, "SoundSequence", "Sequence");
+       RNA_def_struct_ui_text(srna, "Sound Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Sequence");
 
        prop= RNA_def_property(srna, "sound", PROP_POINTER, PROP_NONE);
@@ -611,7 +623,8 @@ static void rna_def_effect(BlenderRNA *brna)
 {
        StructRNA *srna;
 
-       srna = RNA_def_struct(brna, "EffectSequence", "Sequence", "Effect Sequence");
+       srna = RNA_def_struct(brna, "EffectSequence", "Sequence");
+       RNA_def_struct_ui_text(srna, "Effect Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "Sequence");
 
        rna_def_proxy(srna);
@@ -622,7 +635,8 @@ static void rna_def_plugin(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "PluginSequence", "EffectSequence", "Plugin Sequence");
+       srna = RNA_def_struct(brna, "PluginSequence", "EffectSequence");
+       RNA_def_struct_ui_text(srna, "Plugin Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "PluginSeq", "plugin");
 
        prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
@@ -654,7 +668,8 @@ static void rna_def_wipe(BlenderRNA *brna)
                {0, NULL, NULL, NULL}
        };
 
-       srna = RNA_def_struct(brna, "WipeSequence", "EffectSequence", "Wipe Sequence");
+       srna = RNA_def_struct(brna, "WipeSequence", "EffectSequence");
+       RNA_def_struct_ui_text(srna, "Wipe Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "WipeVars", "effectdata");
 
        prop= RNA_def_property(srna, "blur_width", PROP_FLOAT, PROP_UNSIGNED);
@@ -683,7 +698,8 @@ static void rna_def_glow(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "GlowSequence", "EffectSequence", "Glow Sequence");
+       srna = RNA_def_struct(brna, "GlowSequence", "EffectSequence");
+       RNA_def_struct_ui_text(srna, "Glow Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "GlowVars", "effectdata");
        
        prop= RNA_def_property(srna, "threshold", PROP_FLOAT, PROP_NONE);
@@ -734,7 +750,8 @@ static void rna_def_transform(BlenderRNA *brna)
                {0, NULL, NULL, NULL}
        };
 
-       srna = RNA_def_struct(brna, "TransformSequence", "EffectSequence", "Transform Sequence");
+       srna = RNA_def_struct(brna, "TransformSequence", "EffectSequence");
+       RNA_def_struct_ui_text(srna, "Transform Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "TransformVars", "effectdata");
        
        prop= RNA_def_property(srna, "scale_start_x", PROP_FLOAT, PROP_UNSIGNED);
@@ -802,7 +819,8 @@ static void rna_def_solid_color(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna = RNA_def_struct(brna, "ColorSequence", "EffectSequence", "Color Sequence");
+       srna = RNA_def_struct(brna, "ColorSequence", "EffectSequence");
+       RNA_def_struct_ui_text(srna, "Color Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "SolidColorVars", "effectdata");
        
        prop= RNA_def_property(srna, "color", PROP_FLOAT, PROP_COLOR);
@@ -815,7 +833,8 @@ static void rna_def_speed_control(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna = RNA_def_struct(brna, "SpeedControlSequence", "EffectSequence", "SpeedControl Sequence");
+       srna = RNA_def_struct(brna, "SpeedControlSequence", "EffectSequence");
+       RNA_def_struct_ui_text(srna, "SpeedControl Sequence", "DOC_BROKEN");
        RNA_def_struct_sdna_from(srna, "SpeedControlVars", "effectdata");
        
        prop= RNA_def_property(srna, "global_speed", PROP_FLOAT, PROP_UNSIGNED);
index 3dbf6858c5024242559435422fe2545452434b79..19fa1fd7ad19bb0614b148bd7c1a3948b5f9a97b 100644 (file)
@@ -40,7 +40,8 @@ void RNA_def_vfont(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
        
-       srna= RNA_def_struct(brna, "VectorFont", "ID", "Vector Font");
+       srna= RNA_def_struct(brna, "VectorFont", "ID");
+       RNA_def_struct_ui_text(srna, "Vector Font", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "VFont");
 
        prop= RNA_def_property(srna, "filename", PROP_STRING, PROP_FILEPATH);
index c039bd79ac4d0b37521a58fba33cded74d8c0296..a7a510bc42835c6b79df915959786cfbc951305d 100644 (file)
@@ -75,7 +75,8 @@ static void rna_def_operator(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "Operator", NULL, "Operator");
+       srna= RNA_def_struct(brna, "Operator", NULL);
+       RNA_def_struct_ui_text(srna, "Operator", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "wmOperator");
 
        prop= RNA_def_property(srna, "name", PROP_STRING, PROP_NONE);
@@ -88,7 +89,8 @@ static void rna_def_operator(BlenderRNA *brna)
        RNA_def_property_struct_type(prop, "OperatorProperties");
        RNA_def_property_ui_text(prop, "Properties", "");
 
-       srna= RNA_def_struct(brna, "OperatorProperties", NULL, "Operator Properties");
+       srna= RNA_def_struct(brna, "OperatorProperties", NULL);
+       RNA_def_struct_ui_text(srna, "Operator Properties", "DOC_BROKEN");
        RNA_def_struct_funcs(srna, NULL, "rna_OperatorProperties_refine");
 }
 
@@ -97,7 +99,8 @@ static void rna_def_windowmanager(BlenderRNA *brna)
        StructRNA *srna;
        PropertyRNA *prop;
 
-       srna= RNA_def_struct(brna, "WindowManager", "ID", "Window Manager");
+       srna= RNA_def_struct(brna, "WindowManager", "ID");
+       RNA_def_struct_ui_text(srna, "Window Manager", "DOC_BROKEN");
        RNA_def_struct_sdna(srna, "wmWindowManager");
 
        prop= RNA_def_property(srna, "operators", PROP_COLLECTION, PROP_NONE);
index 6e41b8768b53d347159028076fa4c33ab8f32111..faf8a17363becb018e1e319910c87d3954fc258e 100644 (file)
@@ -53,7 +53,8 @@ void RNA_def_world(BlenderRNA *brna)
                {PROP_TIME, "TIME", "Time", ""},
                {0, NULL, NULL, NULL}};
 */
-       srna= RNA_def_struct(brna, "World", "ID" , "World");
+       srna= RNA_def_struct(brna, "World", "ID");
+       RNA_def_struct_ui_text(srna, "World", "DOC_BROKEN");
 
        rna_def_ipo_common(srna);
 
index 6f5b09d7d95db29dfd2f656569c54335f71aedae..1c8f0601b681edeeba99b2f97a645a981dff6518 100644 (file)
@@ -81,9 +81,10 @@ void WM_operatortype_append(void (*opfunc)(wmOperatorType*))
        wmOperatorType *ot;
        
        ot= MEM_callocN(sizeof(wmOperatorType), "operatortype");
-       ot->srna= RNA_def_struct(&BLENDER_RNA, "", "OperatorProperties", "");
+       ot->srna= RNA_def_struct(&BLENDER_RNA, "", "OperatorProperties");
        opfunc(ot);
-       RNA_def_struct_identifier(ot->srna, ot->idname, ot->name);
+       RNA_def_struct_ui_text(ot->srna, ot->name, "DOC_BROKEN"); /* TODO - add a discription to wmOperatorType? */
+       RNA_def_struct_identifier(ot->srna, ot->idname);
        BLI_addtail(&global_ops, ot);
 }