From 9b89de2571b0c3fa2276b5c2ae589e0ec831d1f5 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Sat, 3 Jul 2021 23:08:40 +1000 Subject: Cleanup: consistent use of tags: NOTE/TODO/FIXME/XXX Also use doxy style function reference `#` prefix chars when referencing identifiers. --- source/blender/editors/armature/armature_add.c | 6 +++--- source/blender/editors/armature/armature_edit.c | 12 ++++++------ source/blender/editors/armature/armature_naming.c | 4 ++-- source/blender/editors/armature/armature_relations.c | 6 +++--- source/blender/editors/armature/armature_select.c | 2 +- source/blender/editors/armature/armature_utils.c | 2 +- source/blender/editors/armature/pose_edit.c | 12 ++++++------ source/blender/editors/armature/pose_select.c | 6 +++--- source/blender/editors/armature/pose_slide.c | 4 ++-- source/blender/editors/armature/pose_transform.c | 6 +++--- 10 files changed, 30 insertions(+), 30 deletions(-) (limited to 'source/blender/editors/armature') diff --git a/source/blender/editors/armature/armature_add.c b/source/blender/editors/armature/armature_add.c index baa279dea11..45bf18fe1bb 100644 --- a/source/blender/editors/armature/armature_add.c +++ b/source/blender/editors/armature/armature_add.c @@ -225,7 +225,7 @@ static int armature_click_extrude_exec(bContext *C, wmOperator *UNUSED(op)) static int armature_click_extrude_invoke(bContext *C, wmOperator *op, const wmEvent *event) { - /* TODO most of this code is copied from set3dcursor_invoke, + /* TODO: most of this code is copied from set3dcursor_invoke, * it would be better to reuse code in set3dcursor_invoke */ /* temporarily change 3d cursor position */ @@ -1601,7 +1601,7 @@ static int armature_bone_primitive_add_exec(bContext *C, wmOperator *op) ED_armature_edit_refresh_layer_used(obedit->data); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, obedit); DEG_id_tag_update(&obedit->id, ID_RECALC_SELECT); ED_outliner_select_sync_from_edit_bone_tag(C); @@ -1692,7 +1692,7 @@ static int armature_subdivide_exec(bContext *C, wmOperator *op) } CTX_DATA_END; - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, obedit); DEG_id_tag_update(&obedit->id, ID_RECALC_SELECT); ED_outliner_select_sync_from_edit_bone_tag(C); diff --git a/source/blender/editors/armature/armature_edit.c b/source/blender/editors/armature/armature_edit.c index 48b487c29fd..ea6c71fd33f 100644 --- a/source/blender/editors/armature/armature_edit.c +++ b/source/blender/editors/armature/armature_edit.c @@ -228,7 +228,7 @@ float ED_armature_ebone_roll_to_vector(const EditBone *bone, return roll; } -/* note, ranges arithmetic is used below */ +/* NOTE: ranges arithmetic is used below. */ typedef enum eCalcRollTypes { /* pos */ CALC_ROLL_POS_X = 0, @@ -449,7 +449,7 @@ static int armature_calc_roll_exec(bContext *C, wmOperator *op) } if (changed) { - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob); DEG_id_tag_update(&arm->id, ID_RECALC_SELECT); } @@ -519,7 +519,7 @@ static int armature_roll_clear_exec(bContext *C, wmOperator *op) } if (changed) { - /* Note, notifier might evolve. */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob); DEG_id_tag_update(&arm->id, ID_RECALC_SELECT); } @@ -577,7 +577,7 @@ static void chains_find_tips(ListBase *edbo, ListBase *list) EditBone *curBone, *ebo; LinkData *ld; - /* note: this is potentially very slow ... there's got to be a better way */ + /* NOTE: this is potentially very slow ... there's got to be a better way. */ for (curBone = edbo->first; curBone; curBone = curBone->next) { short stop = 0; @@ -1000,7 +1000,7 @@ static int armature_switch_direction_exec(bContext *C, wmOperator *UNUSED(op)) armature_clear_swap_done_flags(arm); armature_tag_unselect(arm); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob); DEG_id_tag_update(&arm->id, ID_RECALC_SELECT); } @@ -1151,7 +1151,7 @@ static int armature_align_bones_exec(bContext *C, wmOperator *op) op->reports, RPT_INFO, "%d bones aligned to bone '%s'", num_selected_bones, actbone->name); } - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob); DEG_id_tag_update(&arm->id, ID_RECALC_SELECT); diff --git a/source/blender/editors/armature/armature_naming.c b/source/blender/editors/armature/armature_naming.c index 70154695dcd..35bd30377c8 100644 --- a/source/blender/editors/armature/armature_naming.c +++ b/source/blender/editors/armature/armature_naming.c @@ -69,7 +69,7 @@ /** \name Unique Bone Name Utility (Edit Mode) * \{ */ -/* note: there's a ed_armature_bone_unique_name() too! */ +/* NOTE: there's a ed_armature_bone_unique_name() too! */ static bool editbone_unique_check(void *arg, const char *name) { struct { @@ -589,7 +589,7 @@ static int armature_autoside_names_exec(bContext *C, wmOperator *op) /* Since we renamed stuff... */ DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY); - /* Note, notifier might evolve. */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); } MEM_freeN(objects); diff --git a/source/blender/editors/armature/armature_relations.c b/source/blender/editors/armature/armature_relations.c index c447138f00c..32fd1c9ad41 100644 --- a/source/blender/editors/armature/armature_relations.c +++ b/source/blender/editors/armature/armature_relations.c @@ -703,7 +703,7 @@ static int separate_armature_exec(bContext *C, wmOperator *op) ok = true; - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob_old); } MEM_freeN(bases); @@ -893,7 +893,7 @@ static int armature_parent_set_exec(bContext *C, wmOperator *op) } } - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob); DEG_id_tag_update(&ob->id, ID_RECALC_SELECT); @@ -1004,7 +1004,7 @@ static int armature_parent_clear_exec(bContext *C, wmOperator *op) ED_armature_edit_sync_selection(arm->edbo); - /* Note, notifier might evolve. */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_BONE_SELECT, ob); } MEM_freeN(objects); diff --git a/source/blender/editors/armature/armature_select.c b/source/blender/editors/armature/armature_select.c index 65f30c3729f..bd799c00373 100644 --- a/source/blender/editors/armature/armature_select.c +++ b/source/blender/editors/armature/armature_select.c @@ -1426,7 +1426,7 @@ static void armature_select_more_less(Object *ob, bool more) bArmature *arm = (bArmature *)ob->data; EditBone *ebone; - /* XXX, eventually we shouldn't need this - campbell */ + /* XXX(campbell): eventually we shouldn't need this. */ ED_armature_edit_sync_selection(arm->edbo); /* count bones & store selection state */ diff --git a/source/blender/editors/armature/armature_utils.c b/source/blender/editors/armature/armature_utils.c index bc6d0687654..874f1b49451 100644 --- a/source/blender/editors/armature/armature_utils.c +++ b/source/blender/editors/armature/armature_utils.c @@ -391,7 +391,7 @@ void armature_tag_unselect(bArmature *arm) void ED_armature_ebone_transform_mirror_update(bArmature *arm, EditBone *ebo, bool check_select) { - /* TODO When this function is called by property updates, + /* TODO: When this function is called by property updates, * canceling the value change will not restore mirrored bone correctly. */ /* Currently check_select==true when this function is called from a transform operator, diff --git a/source/blender/editors/armature/pose_edit.c b/source/blender/editors/armature/pose_edit.c index f86cc1159d5..58062967b26 100644 --- a/source/blender/editors/armature/pose_edit.c +++ b/source/blender/editors/armature/pose_edit.c @@ -567,7 +567,7 @@ static int pose_flip_names_exec(bContext *C, wmOperator *op) /* since we renamed stuff... */ DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); } FOREACH_OBJECT_IN_MODE_END; @@ -618,7 +618,7 @@ static int pose_autoside_names_exec(bContext *C, wmOperator *op) /* since we renamed stuff... */ DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); ob_prev = ob; } @@ -760,7 +760,7 @@ static int pose_armature_layers_showall_exec(bContext *C, wmOperator *op) RNA_boolean_set_array(&ptr, "layers", layers); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); DEG_id_tag_update(&arm->id, ID_RECALC_COPY_ON_WRITE); @@ -833,7 +833,7 @@ static int armature_layers_exec(bContext *C, wmOperator *op) RNA_id_pointer_create((ID *)arm, &ptr); RNA_boolean_set_array(&ptr, "layers", layers); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); DEG_id_tag_update(&arm->id, ID_RECALC_COPY_ON_WRITE); @@ -919,7 +919,7 @@ static int pose_bone_layers_exec(bContext *C, wmOperator *op) RNA_boolean_set_array(&ptr, "layers", layers); if (prev_ob != ob) { - /* Note, notifier might evolve. */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); DEG_id_tag_update((ID *)ob->data, ID_RECALC_COPY_ON_WRITE); prev_ob = ob; @@ -998,7 +998,7 @@ static int armature_bone_layers_exec(bContext *C, wmOperator *op) ED_armature_edit_refresh_layer_used(ob->data); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); return OPERATOR_FINISHED; diff --git a/source/blender/editors/armature/pose_select.c b/source/blender/editors/armature/pose_select.c index 8fc06a5f962..c39fcb790dd 100644 --- a/source/blender/editors/armature/pose_select.c +++ b/source/blender/editors/armature/pose_select.c @@ -69,7 +69,7 @@ /* ***************** Pose Select Utilities ********************* */ -/* Note: SEL_TOGGLE is assumed to have already been handled! */ +/* NOTE: SEL_TOGGLE is assumed to have already been handled! */ static void pose_do_bone_select(bPoseChannel *pchan, const int select_mode) { /* select pchan only if selectable, but deselect works always */ @@ -161,9 +161,9 @@ void ED_armature_pose_select_pick_bone(ViewLayer *view_layer, /* Since we do unified select, we don't shift+select a bone if the * armature object was not active yet. - * Note, special exception for armature mode so we can do multi-select + * NOTE(campbell): special exception for armature mode so we can do multi-select * we could check for multi-select explicitly but think its fine to - * always give predictable behavior in weight paint mode - campbell */ + * always give predictable behavior in weight paint mode. */ if ((ob_act == NULL) || ((ob_act != ob) && (ob_act->mode & OB_MODE_ALL_WEIGHT_PAINT) == 0)) { /* When we are entering into posemode via toggle-select, * from another active object - always select the bone. */ diff --git a/source/blender/editors/armature/pose_slide.c b/source/blender/editors/armature/pose_slide.c index 9b1de742332..f01afcfc578 100644 --- a/source/blender/editors/armature/pose_slide.c +++ b/source/blender/editors/armature/pose_slide.c @@ -1005,14 +1005,14 @@ static void pose_slide_rest_pose_apply(bContext *C, tPoseSlideOp *pso) if (ELEM(pso->channels, PS_TFM_ALL, PS_TFM_BBONE_SHAPE) && (pchan->flag & POSE_BBONE_SHAPE)) { /* Bbone properties - they all start a "bbone_" prefix. */ - /* TODO Not implemented */ + /* TODO: Not implemented. */ // pose_slide_apply_props(pso, pfl, "bbone_"); } if (ELEM(pso->channels, PS_TFM_ALL, PS_TFM_PROPS) && (pfl->oldprops)) { /* Not strictly a transform, but custom properties contribute * to the pose produced in many rigs (e.g. the facial rigs used in Sintel). */ - /* TODO Not implemented */ + /* TODO: Not implemented. */ // pose_slide_apply_props(pso, pfl, "[\""); } } diff --git a/source/blender/editors/armature/pose_transform.c b/source/blender/editors/armature/pose_transform.c index e597fd46106..1118e84ef4f 100644 --- a/source/blender/editors/armature/pose_transform.c +++ b/source/blender/editors/armature/pose_transform.c @@ -457,7 +457,7 @@ static int apply_armature_pose2bones_exec(bContext *C, wmOperator *op) /* For the affected bones, reset specific constraints that are now known to be invalid. */ applyarmature_reset_constraints(pose, use_selected); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); DEG_id_tag_update(&ob->id, ID_RECALC_COPY_ON_WRITE); @@ -557,7 +557,7 @@ static int pose_visual_transform_apply_exec(bContext *C, wmOperator *UNUSED(op)) DEG_id_tag_update(&ob->id, ID_RECALC_GEOMETRY); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_POSE, ob); } @@ -1228,7 +1228,7 @@ static int pose_clear_transform_generic_exec(bContext *C, DEG_id_tag_update(&ob_iter->id, ID_RECALC_GEOMETRY); - /* note, notifier might evolve */ + /* NOTE: notifier might evolve. */ WM_event_add_notifier(C, NC_OBJECT | ND_TRANSFORM, ob_iter); } } -- cgit v1.2.3