From 8574d68aa0ea123bf3f37ca36fd41b7dcf26403f Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 6 Mar 2020 11:40:37 +1100 Subject: Cleanup: spelling --- source/blender/blenkernel/intern/armature.c | 8 +++++--- source/blender/blenlib/BLI_dlrbTree.h | 8 ++++---- source/blender/editors/armature/armature_utils.c | 2 +- source/blender/editors/object/object_edit.c | 2 +- source/blender/makesdna/DNA_action_types.h | 9 +++++---- source/blender/makesdna/DNA_constraint_types.h | 8 +++++--- 6 files changed, 21 insertions(+), 16 deletions(-) (limited to 'source') diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c index 476756d0580..3216837ae16 100644 --- a/source/blender/blenkernel/intern/armature.c +++ b/source/blender/blenkernel/intern/armature.c @@ -2442,8 +2442,10 @@ void vec_roll_to_mat3(const float vec[3], const float roll, float mat[3][3]) vec_roll_to_mat3_normalized(nor, roll, mat); } -/* recursive part, calculates restposition of entire tree of children */ -/* used by exiting editmode too */ +/** + * Recursive part, calculates rest-position of entire tree of children. + * \note Used when exiting edit-mode too. + */ void BKE_armature_where_is_bone(Bone *bone, const Bone *bone_parent, const bool use_recursion) { float vec[3]; @@ -2914,7 +2916,7 @@ void BKE_pose_where_is(struct Depsgraph *depsgraph, Scene *scene, Object *ob) ctime = BKE_scene_frame_get(scene); /* not accurate... */ - /* In editmode or restposition we read the data from the bones */ + /* In edit-mode or rest-position we read the data from the bones. */ if (arm->edbo || (arm->flag & ARM_RESTPOS)) { for (pchan = ob->pose->chanbase.first; pchan; pchan = pchan->next) { bone = pchan->bone; diff --git a/source/blender/blenlib/BLI_dlrbTree.h b/source/blender/blenlib/BLI_dlrbTree.h index 277d9116558..5db0dd16a34 100644 --- a/source/blender/blenlib/BLI_dlrbTree.h +++ b/source/blender/blenlib/BLI_dlrbTree.h @@ -74,8 +74,8 @@ typedef struct DLRBT_Tree { /* Return -1, 0, 1 for whether the given data is less than, * equal to, or greater than the given node. - * - node: the node to compare to - * - data: pointer to the relevant data or values stored in the bitpattern + * - node: the node to compare to. + * - data: pointer to the relevant data or values stored in the bit-pattern. * dependent on the function. */ typedef short (*DLRBT_Comparator_FP)(void *node, void *data); @@ -85,9 +85,9 @@ typedef short (*DLRBT_Comparator_FP)(void *node, void *data); */ typedef DLRBT_Node *(*DLRBT_NAlloc_FP)(void *data); -/* Update an existing node instance accordingly to be in sync with the given data * +/* Update an existing node instance accordingly to be in sync with the given data. * - node: the node to update. - * - data: Pointer to the relevant data or values stored in the bitpattern + * - data: Pointer to the relevant data or values stored in the bit-pattern. * dependent on the function. */ typedef void (*DLRBT_NUpdate_FP)(void *node, void *data); diff --git a/source/blender/editors/armature/armature_utils.c b/source/blender/editors/armature/armature_utils.c index 451148ed936..a291bbc66e8 100644 --- a/source/blender/editors/armature/armature_utils.c +++ b/source/blender/editors/armature/armature_utils.c @@ -677,7 +677,7 @@ static void armature_finalize_restpose(ListBase *bonelist, ListBase *editbonelis curBone->roll = -atan2f(difmat[2][0], difmat[2][2]); - /* and set restposition again */ + /* And set rest-position again. */ BKE_armature_where_is_bone(curBone, curBone->parent, false); break; } diff --git a/source/blender/editors/object/object_edit.c b/source/blender/editors/object/object_edit.c index e6006ecbc62..f9ac0474d44 100644 --- a/source/blender/editors/object/object_edit.c +++ b/source/blender/editors/object/object_edit.c @@ -629,7 +629,7 @@ bool ED_object_editmode_enter_ex(Main *bmain, Scene *scene, Object *ob, int flag bArmature *arm = ob->data; ok = 1; ED_armature_to_edit(arm); - /* to ensure all goes in restposition and without striding */ + /* To ensure all goes in rest-position and without striding. */ arm->needs_flush_to_id = 0; diff --git a/source/blender/makesdna/DNA_action_types.h b/source/blender/makesdna/DNA_action_types.h index 64a458cbbc5..4b696e29a52 100644 --- a/source/blender/makesdna/DNA_action_types.h +++ b/source/blender/makesdna/DNA_action_types.h @@ -208,10 +208,11 @@ typedef struct bPoseChannel_Runtime { /* PoseChannel ------------------------------------ */ -/* PoseChannel +/** + * PoseChannel * - * A PoseChannel stores the results of Actions and transform information - * with respect to the restposition of Armature bones + * A #bPoseChannel stores the results of Actions and transform information + * with respect to the rest-position of #bArmature bones. */ typedef struct bPoseChannel { struct bPoseChannel *next, *prev; @@ -297,7 +298,7 @@ typedef struct bPoseChannel { float disp_tail_mat[4][4]; /** * Inverse result of constraints. - * doesn't include effect of restposition, parent, and local transform. + * doesn't include effect of rest-position, parent, and local transform. */ float constinv[4][4]; diff --git a/source/blender/makesdna/DNA_constraint_types.h b/source/blender/makesdna/DNA_constraint_types.h index 670a6c46187..18a4a134b71 100644 --- a/source/blender/makesdna/DNA_constraint_types.h +++ b/source/blender/makesdna/DNA_constraint_types.h @@ -497,7 +497,7 @@ typedef struct bPivotConstraint { float offset[3]; /* Rotation-driven activation: - * This option provides easier one-stop setups for footrolls + * This option provides easier one-stop setups for foot-rolls. */ /** Rotation axes to consider for this (#ePivotConstraint_Axis). */ short rotAxis; @@ -715,8 +715,10 @@ typedef enum eBConstraint_Flags { typedef enum eBConstraint_SpaceTypes { /** Default for all - worldspace. */ CONSTRAINT_SPACE_WORLD = 0, - /** For objects (relative to parent/without parent influence), - * for bones (along normals of bone, without parent/restpositions). */ + /** + * For objects (relative to parent/without parent influence), + * for bones (along normals of bone, without parent/rest-positions). + */ CONSTRAINT_SPACE_LOCAL = 1, /** For posechannels - pose space. */ CONSTRAINT_SPACE_POSE = 2, -- cgit v1.2.3