diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-02-13 09:44:51 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-02-13 09:44:51 +0300 |
commit | fea335fe8bd01675243953e41f59f156e44f1e94 (patch) | |
tree | 7d14301caa35270b4a3077340f4a33814d683d12 /source/blender/makesdna | |
parent | 474947c465d5c78b548669795095663b4970b718 (diff) |
Cleanup: spelling
Diffstat (limited to 'source/blender/makesdna')
19 files changed, 74 insertions, 69 deletions
diff --git a/source/blender/makesdna/DNA_ID.h b/source/blender/makesdna/DNA_ID.h index 00d0d4e3626..9d01617905f 100644 --- a/source/blender/makesdna/DNA_ID.h +++ b/source/blender/makesdna/DNA_ID.h @@ -467,7 +467,7 @@ typedef struct PreviewImage { } \ ((void)0) -/** id->flag (persitent). */ +/** id->flag (persistent). */ enum { /** Don't delete the datablock even if unused. */ LIB_FAKEUSER = 1 << 9, @@ -534,7 +534,7 @@ enum { /* tag data-block as having an extra user. */ LIB_TAG_EXTRAUSER = 1 << 2, - /* tag data-block as having actually increased usercount for the extra virtual user. */ + /* tag data-block as having actually increased user-count for the extra virtual user. */ LIB_TAG_EXTRAUSER_SET = 1 << 7, /* RESET_AFTER_USE tag newly duplicated/copied IDs. diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h index 96245e3b067..27374c451e9 100644 --- a/source/blender/makesdna/DNA_action_types.h +++ b/source/blender/makesdna/DNA_action_types.h @@ -290,13 +290,13 @@ typedef struct bPoseChannel { /** Matrix result of loc/quat/size, and where we put deform in, see next line */ float chan_mat[4][4]; /** - * Constraints accumulate here. in the end, pose_mat = bone->arm_mat * chan_mat + * Constraints accumulate here. in the end, `pose_mat = bone->arm_mat * chan_mat` * this matrix is object space. */ float pose_mat[4][4]; /** For display, pose_mat with bone length applied. */ float disp_mat[4][4]; - /** For display, pose_mat with bone length applied and translated to tai.l*/ + /** For display, pose_mat with bone length applied and translated to tail. */ float disp_tail_mat[4][4]; /** * Inverse result of constraints. @@ -653,7 +653,7 @@ typedef enum eActionGroup_Flag { * that affects a group of related settings (as defined by the user). */ typedef struct bAction { - /** ID-serialisation for relinking. */ + /** ID-serialization for relinking. */ ID id; /** Function-curves (FCurve). */ diff --git a/source/blender/makesdna/DNA_armature_types.h b/source/blender/makesdna/DNA_armature_types.h index de2d56bb264..09304ce09f2 100644 --- a/source/blender/makesdna/DNA_armature_types.h +++ b/source/blender/makesdna/DNA_armature_types.h @@ -42,23 +42,23 @@ struct AnimData; */ typedef struct Bone { - /** Next/prev elements within this list. */ + /** Next/previous elements within this list. */ struct Bone *next, *prev; /** User-Defined Properties on this Bone. */ IDProperty *prop; - /** Parent (ik parent if appropriate flag is set. */ + /** Parent (IK parent if appropriate flag is set). */ struct Bone *parent; - /** Children . */ + /** Children. */ ListBase childbase; - /** Name of the bone - must be unique within the armature, MAXBONENAME. */ + /** Name of the bone - must be unique within the armature, MAXBONENAME. */ char name[64]; - /** roll is input for editmode, length calculated. */ + /** Roll is input for edit-mode, length calculated. */ float roll; float head[3]; - /** head/tail and roll in Bone Space . */ + /** Head/tail and roll in Bone Space. */ float tail[3]; - /** rotation derived from head/tail/roll. */ + /** Rotation derived from head/tail/roll. */ float bone_mat[3][3]; int flag; @@ -67,21 +67,24 @@ typedef struct Bone { char _pad[7]; float arm_head[3]; - /** head/tail in Armature Space (rest pos). */ + /** Head/tail in Armature Space (rest pose). */ float arm_tail[3]; - /** matrix: (bonemat(b)+head(b))*arm_mat(b-1), rest po.s*/ + /** Matrix: `(bonemat(b)+head(b))*arm_mat(b-1)`, rest pose. */ float arm_mat[4][4]; - /** Roll in Armature Space (rest pos). */ + /** Roll in Armature Space (rest pose). */ float arm_roll; - /** dist, weight: for non-deformgroup deforms. */ + /** dist, weight: for non-deformgroup deforms. */ float dist, weight; - /** width: for block bones. keep in this order, transform!. */ + /** width: for block bones. keep in this order, transform!. */ float xwidth, length, zwidth; - /** Radius for head/tail sphere, defining deform as well, parent->rad_tip overrides rad_head. */ + /** + * Radius for head/tail sphere, defining deform as well, + * `parent->rad_tip` overrides `rad_head`. + */ float rad_head, rad_tail; - /** Curved bones settings - these define the "restpose" for a curved bone. */ + /** Curved bones settings - these define the "rest-pose" for a curved bone. */ float roll1, roll2; float curve_in_x, curve_in_y; float curve_out_x, curve_out_y; @@ -90,11 +93,11 @@ typedef struct Bone { float scale_in_x, scale_in_y; float scale_out_x, scale_out_y; - /** patch for upward compat, UNUSED!. */ + /** Patch for upward compatibility, UNUSED! */ float size[3]; /** Layers that bone appears on. */ int layer; - /** for B-bones. */ + /** For B-bones. */ short segments; /** Type of next/prev bone handles. */ @@ -126,7 +129,7 @@ typedef struct bArmature { /** Active bone. */ Bone *act_bone; - /** Active editbone (in editmode). */ + /** Active edit-bone (in edit-mode). */ struct EditBone *act_edbone; /** ID data is older than edit-mode data (TODO: move to edit-mode struct). */ diff --git a/source/blender/makesdna/DNA_cloth_types.h b/source/blender/makesdna/DNA_cloth_types.h index 1eff7be3f15..386590ad26c 100644 --- a/source/blender/makesdna/DNA_cloth_types.h +++ b/source/blender/makesdna/DNA_cloth_types.h @@ -52,7 +52,7 @@ typedef struct ClothSimSettings { float Cvi; /** Gravity/external force vector. */ float gravity[3]; - /** This is the duration of our time step, computed.. */ + /** This is the duration of our time step, computed. */ float dt; /** The mass of the entire cloth. */ float mass; @@ -78,9 +78,9 @@ typedef struct ClothSimSettings { float time_scale; /** See SB. */ float maxgoal; - /** Scaling of effector forces (see softbody_calc_forces)..*/ + /** Scaling of effector forces (see #softbody_calc_forces). */ float eff_force_scale; - /** Scaling of effector wind (see softbody_calc_forces).. */ + /** Scaling of effector wind (see #softbody_calc_forces). */ float eff_wind_scale; float sim_time_old; float defgoal; diff --git a/source/blender/makesdna/DNA_constraint_types.h b/source/blender/makesdna/DNA_constraint_types.h index ddc1b3bd9d7..07fbf263d80 100644 --- a/source/blender/makesdna/DNA_constraint_types.h +++ b/source/blender/makesdna/DNA_constraint_types.h @@ -72,9 +72,9 @@ typedef struct bConstraint { /** Constraint name, MAX_NAME. */ char name[64]; - /** Amount of influence exherted by constraint (0.0-1.0). */ + /** Amount of influence exerted by constraint (0.0-1.0). */ float enforce; - /** Point along subtarget bone where the actual target is. 0=head (default for all), 1=tail. */ + /** Point along `subtarget` bone where the actual target is. 0=head (default for all), 1=tail. */ float headtail; /* old animation system, deprecated for 2.5. */ diff --git a/source/blender/makesdna/DNA_curve_types.h b/source/blender/makesdna/DNA_curve_types.h index 3bf58203bef..b3f0708539a 100644 --- a/source/blender/makesdna/DNA_curve_types.h +++ b/source/blender/makesdna/DNA_curve_types.h @@ -600,10 +600,10 @@ enum { CU_CHINFO_BOLD = 1 << 0, CU_CHINFO_ITALIC = 1 << 1, CU_CHINFO_UNDERLINE = 1 << 2, - /** wordwrap occurred here */ + /** Word-wrap occurred here. */ CU_CHINFO_WRAP = 1 << 3, CU_CHINFO_SMALLCAPS = 1 << 4, - /** set at runtime, checks if case switching is needed */ + /** Set at runtime, checks if case switching is needed. */ CU_CHINFO_SMALLCAPS_CHECK = 1 << 5, /** Set at runtime, indicates char that doesn't fit in text boxes. */ CU_CHINFO_OVERFLOW = 1 << 6, diff --git a/source/blender/makesdna/DNA_material_types.h b/source/blender/makesdna/DNA_material_types.h index 919bd18be80..884c2df6480 100644 --- a/source/blender/makesdna/DNA_material_types.h +++ b/source/blender/makesdna/DNA_material_types.h @@ -45,11 +45,11 @@ struct bNodeTree; typedef struct TexPaintSlot { /** Image to be painted on. */ struct Image *ima; - /** Customdata index for uv layer, MAX_NAM.E*/ + /** Custom-data index for uv layer, #MAX_NAME. */ char *uvname; /** Do we have a valid image and UV map. */ int valid; - /** Copy of node inteporlation setting. */ + /** Copy of node interpolation setting. */ int interp; } TexPaintSlot; diff --git a/source/blender/makesdna/DNA_meta_types.h b/source/blender/makesdna/DNA_meta_types.h index a827003a9a0..a991f654b09 100644 --- a/source/blender/makesdna/DNA_meta_types.h +++ b/source/blender/makesdna/DNA_meta_types.h @@ -128,9 +128,9 @@ typedef struct MetaBall { /* ml->type */ #define MB_BALL 0 -#define MB_TUBEX 1 /* depercated */ -#define MB_TUBEY 2 /* depercated */ -#define MB_TUBEZ 3 /* depercated */ +#define MB_TUBEX 1 /* deprecated. */ +#define MB_TUBEY 2 /* deprecated. */ +#define MB_TUBEZ 3 /* deprecated. */ #define MB_TUBE 4 #define MB_PLANE 5 #define MB_ELIPSOID 6 diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index 29421430e5d..6e1c00bfca8 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -1230,12 +1230,14 @@ typedef struct SolidifyModifierData { char defgrp_name[64]; char shell_defgrp_name[64]; char rim_defgrp_name[64]; - /** New surface offset leve.l*/ + /** New surface offset level. */ float offset; - /** Midpoint of the offset . */ + /** Midpoint of the offset. */ float offset_fac; - /** factor for the minimum weight to use when vgroups are used, - * avoids 0.0 weights giving duplicate geometry */ + /** + * Factor for the minimum weight to use when vertex-groups are used, + * avoids 0.0 weights giving duplicate geometry. + */ float offset_fac_vg; /** Clamp offset based on surrounding geometry. */ float offset_clamp; diff --git a/source/blender/makesdna/DNA_movieclip_types.h b/source/blender/makesdna/DNA_movieclip_types.h index 11cdb48edf0..b72b7c41b1c 100644 --- a/source/blender/makesdna/DNA_movieclip_types.h +++ b/source/blender/makesdna/DNA_movieclip_types.h @@ -156,7 +156,7 @@ typedef struct MovieClipScopes { struct MovieTrackingTrack *track; /** Marker scopes are created for. */ struct MovieTrackingMarker *marker; - /** Scale used for sliding from previewe area. */ + /** Scale used for sliding from preview area. */ float slide_scale[2]; } MovieClipScopes; diff --git a/source/blender/makesdna/DNA_node_types.h b/source/blender/makesdna/DNA_node_types.h index fd9fcfa3232..a7b5be753d1 100644 --- a/source/blender/makesdna/DNA_node_types.h +++ b/source/blender/makesdna/DNA_node_types.h @@ -1226,7 +1226,7 @@ typedef struct NodeAttributeSeparateXYZ { /* script node flag */ #define NODE_SCRIPT_AUTO_UPDATE 1 -/* ies node mode */ +/* IES node mode. */ #define NODE_IES_INTERNAL 0 #define NODE_IES_EXTERNAL 1 @@ -1550,7 +1550,7 @@ enum { /* image */ #define CMP_NODE_IMAGE_USE_STRAIGHT_OUTPUT 1 -/* viewer and cmposite output */ +/* viewer and composite output. */ #define CMP_NODE_OUTPUT_IGNORE_ALPHA 1 /* Plane track deform node */ diff --git a/source/blender/makesdna/DNA_object_force_types.h b/source/blender/makesdna/DNA_object_force_types.h index 3bd11d02b7a..7812ff6a4f1 100644 --- a/source/blender/makesdna/DNA_object_force_types.h +++ b/source/blender/makesdna/DNA_object_force_types.h @@ -310,7 +310,7 @@ typedef struct SoftBody { struct Collection *collision_group; struct EffectorWeights *effector_weights; - /* reverse esimated obmatrix .. no need to store in blend file .. how ever who cares */ + /* Reverse estimated object-matrix (run-time data, no need to store in the file). */ float lcom[3]; float lrot[3][3]; float lscale[3][3]; diff --git a/source/blender/makesdna/DNA_particle_types.h b/source/blender/makesdna/DNA_particle_types.h index 10fcca734b2..cc40e26b92b 100644 --- a/source/blender/makesdna/DNA_particle_types.h +++ b/source/blender/makesdna/DNA_particle_types.h @@ -118,10 +118,10 @@ typedef struct ParticleData { /** Boids data. */ BoidParticle *boid; - /** Amount of hair or keyed key.s*/ + /** Amount of hair or keyed keys. */ int totkey; - /** Dietime is not necessarily time+lifetime as. */ + /** Die-time is not necessarily time+lifetime as. */ float time, lifetime; /** Particles can die unnaturally (collision). */ float dietime; diff --git a/source/blender/makesdna/DNA_rigidbody_types.h b/source/blender/makesdna/DNA_rigidbody_types.h index 48f183e1e28..9a3b9e7d365 100644 --- a/source/blender/makesdna/DNA_rigidbody_types.h +++ b/source/blender/makesdna/DNA_rigidbody_types.h @@ -45,7 +45,7 @@ typedef struct RigidBodyWorld_Shared { struct ListBase ptcaches; /* References to Physics Sim objects. Exist at runtime only ---------------------- */ - /** Physics sim world (i.e. btDiscreteDynamicsWorld). */ + /** Physics sim world (i.e. #btDiscreteDynamicsWorld). */ void *physics_world; } RigidBodyWorld_Shared; @@ -63,7 +63,7 @@ typedef struct RigidBodyWorld { /** Array to access group objects by index, only used at runtime. */ struct Object **objects; - /** Group containing objects to use for Rigid Body Constraint.s*/ + /** Group containing objects to use for Rigid Body Constraints. */ struct Collection *constraints; char _pad[4]; @@ -72,19 +72,19 @@ typedef struct RigidBodyWorld { /** This pointer is shared between all evaluated copies. */ struct RigidBodyWorld_Shared *shared; - /** Moved to shared->pointcache. */ + /** Moved to `shared->pointcache`. */ struct PointCache *pointcache DNA_DEPRECATED; - /** Moved to shared->ptcaches. */ + /** Moved to `shared->ptcaches`. */ struct ListBase ptcaches DNA_DEPRECATED; /** Number of objects in rigid body group. */ int numbodies; - /** Number of simulation substeps steps taken per frame. */ + /** Number of simulation sub-steps steps taken per frame. */ short substeps_per_frame; /** Number of constraint solver iterations made per simulation step. */ short num_solver_iterations; - /** (eRigidBodyWorld_Flag) settings for this RigidBodyWorld. */ + /** (#eRigidBodyWorld_Flag) settings for this RigidBodyWorld. */ int flag; /** Used to speed up or slow down the simulation. */ float time_scale; @@ -96,7 +96,7 @@ typedef enum eRigidBodyWorld_Flag { RBW_FLAG_MUTED = (1 << 0), /* sim data needs to be rebuilt */ /* RBW_FLAG_NEEDS_REBUILD = (1 << 1), */ /* UNUSED */ - /* usse split impulse when stepping the simulation */ + /** Use split impulse when stepping the simulation. */ RBW_FLAG_USE_SPLIT_IMPULSE = (1 << 2), } eRigidBodyWorld_Flag; diff --git a/source/blender/makesdna/DNA_scene_types.h b/source/blender/makesdna/DNA_scene_types.h index a7405b64bf9..33d31df4210 100644 --- a/source/blender/makesdna/DNA_scene_types.h +++ b/source/blender/makesdna/DNA_scene_types.h @@ -1100,33 +1100,33 @@ typedef struct GP_Sculpt_Settings { struct GP_Sculpt_Guide guide; } GP_Sculpt_Settings; -/* GP_Sculpt_Settings.flag */ +/** #GP_Sculpt_Settings.flag */ typedef enum eGP_Sculpt_SettingsFlag { - /* enable falloff for multiframe editing */ + /** Enable falloff for multi-frame editing. */ GP_SCULPT_SETT_FLAG_FRAME_FALLOFF = (1 << 0), - /* apply primitive curve */ + /** Apply primitive curve. */ GP_SCULPT_SETT_FLAG_PRIMITIVE_CURVE = (1 << 1), - /* Scale thickness. */ + /** Scale thickness. */ GP_SCULPT_SETT_FLAG_SCALE_THICKNESS = (1 << 3), } eGP_Sculpt_SettingsFlag; -/* GP_Sculpt_Settings.gpencil_selectmode_sculpt */ +/** #GP_Sculpt_Settings.gpencil_selectmode_sculpt */ typedef enum eGP_Sculpt_SelectMaskFlag { - /* only affect selected points */ + /** Only affect selected points. */ GP_SCULPT_MASK_SELECTMODE_POINT = (1 << 0), - /* only affect selected strokes */ + /** Only affect selected strokes. */ GP_SCULPT_MASK_SELECTMODE_STROKE = (1 << 1), - /* only affect selected segmenst */ + /** only affect selected segments. */ GP_SCULPT_MASK_SELECTMODE_SEGMENT = (1 << 2), } eGP_Sculpt_SelectMaskFlag; -/* GP_Sculpt_Settings.gpencil_selectmode_vertex */ +/** #GP_Sculpt_Settings.gpencil_selectmode_vertex */ typedef enum eGP_vertex_SelectMaskFlag { - /* only affect selected points */ + /** Only affect selected points. */ GP_VERTEX_MASK_SELECTMODE_POINT = (1 << 0), - /* only affect selected strokes */ + /** Only affect selected strokes. */ GP_VERTEX_MASK_SELECTMODE_STROKE = (1 << 1), - /* only affect selected segmenst */ + /** Only affect selected segments. */ GP_VERTEX_MASK_SELECTMODE_SEGMENT = (1 << 2), } eGP_Vertex_SelectMaskFlag; diff --git a/source/blender/makesdna/DNA_screen_types.h b/source/blender/makesdna/DNA_screen_types.h index 3a99a6f4ee8..8d3ac3a7814 100644 --- a/source/blender/makesdna/DNA_screen_types.h +++ b/source/blender/makesdna/DNA_screen_types.h @@ -285,7 +285,7 @@ typedef struct uiList { /* some list UI data need to be saved in file */ /** Defined as UI_MAX_NAME_STR. */ char list_id[64]; - /** How items are layedout in the list. */ + /** How items are laid out in the list. */ int layout_type; int flag; @@ -319,7 +319,7 @@ typedef struct TransformOrientation { typedef struct uiPreview { struct uiPreview *next, *prev; - /** Defined as UI_MAX_NAME_STR. */ + /** Defined as #UI_MAX_NAME_STR. */ char preview_id[64]; short height; char _pad1[6]; @@ -360,7 +360,7 @@ typedef struct ScrArea_Runtime { typedef struct ScrArea { struct ScrArea *next, *prev; - /** Ordered (bl, tl, tr, br). */ + /** Ordered (bottom-left, top-left, top-right, bottom-right). */ ScrVert *v1, *v2, *v3, *v4; /** If area==full, this is the parent. */ bScreen *full; diff --git a/source/blender/makesdna/DNA_space_types.h b/source/blender/makesdna/DNA_space_types.h index 51f8b58da62..4d705f3aa34 100644 --- a/source/blender/makesdna/DNA_space_types.h +++ b/source/blender/makesdna/DNA_space_types.h @@ -1545,7 +1545,7 @@ typedef struct SpaceNode { */ ListBase treepath; - /* The tree farthest down in the group heirarchy. */ + /* The tree farthest down in the group hierarchy. */ struct bNodeTree *edittree; struct bNodeTree *nodetree; diff --git a/source/blender/makesdna/DNA_tracking_types.h b/source/blender/makesdna/DNA_tracking_types.h index f08aee317a3..0e673aaec66 100644 --- a/source/blender/makesdna/DNA_tracking_types.h +++ b/source/blender/makesdna/DNA_tracking_types.h @@ -328,7 +328,7 @@ typedef struct MovieTrackingStabilization { float target_pos[2]; /** Expected target rotation of frame after raw stabilization, will be compensated. */ float target_rot; - /** Zoom factor known to be present on original footage. Also used for autoscale. */ + /** Zoom factor known to be present on original footage. Also used for auto-scale. */ float scale; /** Influence on location, scale and rotation. */ diff --git a/source/blender/makesdna/DNA_userdef_types.h b/source/blender/makesdna/DNA_userdef_types.h index 0e31ec3494e..e6e2b6553c0 100644 --- a/source/blender/makesdna/DNA_userdef_types.h +++ b/source/blender/makesdna/DNA_userdef_types.h @@ -1207,7 +1207,7 @@ typedef enum eDupli_ID_Flags { USER_DUP_OBDATA = (~0) & ((1 << 24) - 1), - /* Those are not exposed as user preferences, only used internaly. */ + /* Those are not exposed as user preferences, only used internally. */ USER_DUP_OBJECT = (1 << 24), /* USER_DUP_COLLECTION = (1 << 25), */ /* UNUSED, keep because we may implement. */ |