diff options
author | Campbell Barton <ideasman42@gmail.com> | 2019-04-14 11:48:42 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2019-04-14 11:48:42 +0300 |
commit | eff8cc9cccdaa7248d9d869473704e9db69c2f41 (patch) | |
tree | 95c67fbd688b1f63dfef77372a7eaeb40aa15ec5 /source/blender/editors/armature/armature_utils.c | |
parent | b7e5433890debe629a0677473ba920f743de3342 (diff) |
Cleanup: doxy comments
Use doxy references to function and enums,
also correct some names which became out of sync.
Diffstat (limited to 'source/blender/editors/armature/armature_utils.c')
-rw-r--r-- | source/blender/editors/armature/armature_utils.c | 17 |
1 files changed, 10 insertions, 7 deletions
diff --git a/source/blender/editors/armature/armature_utils.c b/source/blender/editors/armature/armature_utils.c index 6b09912064e..465209eb9c5 100644 --- a/source/blender/editors/armature/armature_utils.c +++ b/source/blender/editors/armature/armature_utils.c @@ -547,13 +547,16 @@ EditBone *make_boneList(ListBase *edbo, ListBase *bones, struct Bone *actBone) return active; } -/* This function: - * - sets local head/tail rest locations using parent bone's arm_mat. - * - calls BKE_armature_where_is_bone() which uses parent's transform (arm_mat) to define this bone's transform. - * - fixes (converts) EditBone roll into Bone roll. - * - calls again BKE_armature_where_is_bone(), since roll fiddling may have changed things for our bone... - * Note that order is crucial here, we can only handle child if all its parents in chain have already been handled - * (this is ensured by recursive process). */ +/** + * This function: + * - Sets local head/tail rest locations using parent bone's arm_mat. + * - Calls #BKE_armature_where_is_bone() which uses parent's transform (arm_mat) to define this bone's transform. + * - Fixes (converts) EditBone roll into Bone roll. + * - Calls again #BKE_armature_where_is_bone(), since roll fiddling may have changed things for our bone... + * + * \note The order is crucial here, we can only handle child + * if all its parents in chain have already been handled (this is ensured by recursive process). + */ static void armature_finalize_restpose(ListBase *bonelist, ListBase *editbonelist) { Bone *curBone; |