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/blenkernel/intern/DerivedMesh.cc | 6 +++--- source/blender/blenkernel/intern/action.c | 2 +- source/blender/blenkernel/intern/anim_data.c | 4 ++-- source/blender/blenkernel/intern/anim_sys.c | 4 ++-- .../blender/blenkernel/intern/anim_visualization.c | 4 ++-- source/blender/blenkernel/intern/armature.c | 6 +++--- source/blender/blenkernel/intern/bpath.c | 2 +- source/blender/blenkernel/intern/brush.c | 4 ++-- source/blender/blenkernel/intern/bvhutils.cc | 4 ++-- source/blender/blenkernel/intern/cdderivedmesh.c | 2 +- source/blender/blenkernel/intern/cloth.c | 6 +++--- source/blender/blenkernel/intern/collection.c | 10 +++++----- source/blender/blenkernel/intern/colorband.c | 4 ++-- source/blender/blenkernel/intern/colortools.c | 6 +++--- source/blender/blenkernel/intern/constraint.c | 20 ++++++++++---------- source/blender/blenkernel/intern/curve.c | 12 ++++++------ source/blender/blenkernel/intern/curve_deform.c | 2 +- source/blender/blenkernel/intern/customdata.c | 16 +++++++++------- source/blender/blenkernel/intern/data_transfer.c | 4 ++-- source/blender/blenkernel/intern/deform.c | 8 ++++---- source/blender/blenkernel/intern/displist_tangent.c | 2 +- source/blender/blenkernel/intern/dynamicpaint.c | 11 ++++++----- source/blender/blenkernel/intern/editmesh.c | 2 +- source/blender/blenkernel/intern/editmesh_bvh.c | 2 +- source/blender/blenkernel/intern/editmesh_tangent.c | 2 +- source/blender/blenkernel/intern/fcurve.c | 2 +- source/blender/blenkernel/intern/fmodifier.c | 2 +- source/blender/blenkernel/intern/font.c | 4 ++-- source/blender/blenkernel/intern/gpencil.c | 2 +- source/blender/blenkernel/intern/gpencil_geom.c | 4 ++-- source/blender/blenkernel/intern/gpencil_modifier.c | 2 +- source/blender/blenkernel/intern/idprop.c | 10 +++++----- source/blender/blenkernel/intern/idprop_utils.c | 2 +- source/blender/blenkernel/intern/image.c | 10 +++++----- source/blender/blenkernel/intern/image_save.c | 2 +- source/blender/blenkernel/intern/ipo.c | 10 +++++----- source/blender/blenkernel/intern/lib_id.c | 18 +++++++++--------- source/blender/blenkernel/intern/lib_id_delete.c | 4 ++-- source/blender/blenkernel/intern/lib_override.c | 16 ++++++++-------- source/blender/blenkernel/intern/lib_query.c | 2 +- source/blender/blenkernel/intern/lib_remap.c | 6 +++--- source/blender/blenkernel/intern/library.c | 4 ++-- source/blender/blenkernel/intern/main.c | 2 +- source/blender/blenkernel/intern/mask.c | 12 ++++++------ source/blender/blenkernel/intern/mask_evaluate.c | 4 ++-- source/blender/blenkernel/intern/mask_rasterize.c | 8 ++++---- source/blender/blenkernel/intern/material.c | 8 ++++---- source/blender/blenkernel/intern/mball.c | 2 +- source/blender/blenkernel/intern/mball_tessellate.c | 4 ++-- source/blender/blenkernel/intern/mesh.c | 12 ++++++------ .../blenkernel/intern/mesh_boolean_convert.cc | 2 +- source/blender/blenkernel/intern/mesh_convert.c | 4 ++-- source/blender/blenkernel/intern/mesh_evaluate.c | 8 ++++---- source/blender/blenkernel/intern/mesh_mapping.c | 4 ++-- source/blender/blenkernel/intern/mesh_merge.c | 2 +- source/blender/blenkernel/intern/mesh_normals.c | 8 ++++---- source/blender/blenkernel/intern/mesh_remap.c | 10 +++++----- source/blender/blenkernel/intern/mesh_runtime.c | 2 +- source/blender/blenkernel/intern/mesh_tangent.c | 4 ++-- source/blender/blenkernel/intern/mesh_validate.c | 6 +++--- source/blender/blenkernel/intern/modifier.c | 2 +- source/blender/blenkernel/intern/movieclip.c | 6 +++--- source/blender/blenkernel/intern/node.cc | 16 ++++++++-------- source/blender/blenkernel/intern/object.c | 14 +++++++------- source/blender/blenkernel/intern/ocean.c | 8 ++++---- source/blender/blenkernel/intern/packedFile.c | 2 +- source/blender/blenkernel/intern/paint.c | 6 +++--- source/blender/blenkernel/intern/particle.c | 6 +++--- source/blender/blenkernel/intern/particle_child.c | 2 +- .../blender/blenkernel/intern/particle_distribute.c | 4 ++-- source/blender/blenkernel/intern/particle_system.c | 16 ++++++++-------- source/blender/blenkernel/intern/pbvh.c | 2 +- source/blender/blenkernel/intern/pbvh_bmesh.c | 2 +- source/blender/blenkernel/intern/pbvh_intern.h | 2 +- source/blender/blenkernel/intern/pointcache.c | 4 ++-- source/blender/blenkernel/intern/rigidbody.c | 6 +++--- source/blender/blenkernel/intern/scene.c | 8 ++++---- source/blender/blenkernel/intern/screen.c | 4 ++-- source/blender/blenkernel/intern/shader_fx.c | 2 +- source/blender/blenkernel/intern/shrinkwrap.c | 4 ++-- source/blender/blenkernel/intern/softbody.c | 2 +- source/blender/blenkernel/intern/subsurf_ccg.c | 2 +- source/blender/blenkernel/intern/text.c | 4 ++-- .../blender/blenkernel/intern/tracking_stabilize.c | 4 ++-- source/blender/blenkernel/intern/undo_system.c | 2 +- source/blender/blenkernel/intern/unit.c | 4 ++-- source/blender/blenkernel/intern/volume.cc | 2 +- 87 files changed, 243 insertions(+), 240 deletions(-) (limited to 'source/blender/blenkernel/intern') diff --git a/source/blender/blenkernel/intern/DerivedMesh.cc b/source/blender/blenkernel/intern/DerivedMesh.cc index bc49c086532..46dec073bab 100644 --- a/source/blender/blenkernel/intern/DerivedMesh.cc +++ b/source/blender/blenkernel/intern/DerivedMesh.cc @@ -829,7 +829,7 @@ static void mesh_calc_modifier_final_normals(const Mesh *mesh_input, } if (do_loop_normals) { - /* Compute loop normals (note: will compute poly and vert normals as well, if needed!) */ + /* Compute loop normals (NOTE: will compute poly and vert normals as well, if needed!). */ BKE_mesh_calc_normals_split(mesh_final); BKE_mesh_tessface_clear(mesh_final); } @@ -1404,7 +1404,7 @@ static void mesh_calc_modifiers(struct Depsgraph *depsgraph, * we need to apply these back onto the Mesh. If we have no * Mesh then we need to build one. */ if (mesh_final == nullptr) { - /* Note: this check on cdmask is a bit dodgy, it handles the issue at stake here (see T68211), + /* NOTE: this check on cdmask is a bit dodgy, it handles the issue at stake here (see T68211), * but other cases might require similar handling? * Could be a good idea to define a proper CustomData_MeshMask for that then. */ if (deformed_verts == nullptr && allow_shared_mesh && @@ -2418,7 +2418,7 @@ static void dm_debug_info_layers(DynStr *dynstr, for (type = 0; type < CD_NUMTYPES; type++) { if (CustomData_has_layer(cd, type)) { - /* note: doesn't account for multiple layers */ + /* NOTE: doesn't account for multiple layers. */ const char *name = CustomData_layertype_name(type); const int size = CustomData_sizeof(type); const void *pt = getElemDataArray(dm, type); diff --git a/source/blender/blenkernel/intern/action.c b/source/blender/blenkernel/intern/action.c index fdf3558abed..13ca5ecf23c 100644 --- a/source/blender/blenkernel/intern/action.c +++ b/source/blender/blenkernel/intern/action.c @@ -120,7 +120,7 @@ static void action_copy_data(Main *UNUSED(bmain), ID *id_dst, const ID *id_src, for (fcurve_src = action_src->curves.first; fcurve_src; fcurve_src = fcurve_src->next) { /* Duplicate F-Curve. */ - /* XXX TODO pass subdata flag? + /* XXX TODO: pass subdata flag? * But surprisingly does not seem to be doing any ID refcounting... */ fcurve_dst = BKE_fcurve_copy(fcurve_src); diff --git a/source/blender/blenkernel/intern/anim_data.c b/source/blender/blenkernel/intern/anim_data.c index 2f71dda17f2..7e5313f0e4a 100644 --- a/source/blender/blenkernel/intern/anim_data.c +++ b/source/blender/blenkernel/intern/anim_data.c @@ -336,7 +336,7 @@ AnimData *BKE_animdata_copy(Main *bmain, AnimData *adt, const int flag) * BKE_id_copy_ex(). * So in case we do copy the ID and its sub-IDs in bmain, silence the 'no usercount' flag for * the sub-IDs copying. - * Note: This is a bit weak, as usually when it comes to recursive ID copy. Should work for + * NOTE: This is a bit weak, as usually when it comes to recursive ID copy. Should work for * now, but we may have to revisit this at some point and add a proper extra flag to deal with * that situation. Or refactor completely the way we handle such recursion, by flattening it * e.g. */ @@ -1563,7 +1563,7 @@ void BKE_animdata_blend_write(BlendWriter *writer, struct AnimData *adt) BLO_write_string(writer, aor->rna_path); } - /* TODO write the remaps (if they are needed) */ + /* TODO: write the remaps (if they are needed). */ /* write NLA data */ BKE_nla_blend_write(writer, &adt->nla_tracks); diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c index 08a3f3fcf4f..553453cd891 100644 --- a/source/blender/blenkernel/intern/anim_sys.c +++ b/source/blender/blenkernel/intern/anim_sys.c @@ -2746,7 +2746,7 @@ static void animsys_evaluate_nla_for_keyframing(PointerRNA *ptr, } } - /** Note: Although we early out, we can still keyframe to the non-pushed action since the + /** NOTE: Although we early out, we can still keyframe to the non-pushed action since the * keyframe remap function detects (r_context->strip.act == NULL) and will keyframe without * remapping. */ @@ -3126,7 +3126,7 @@ static void animsys_evaluate_overrides(PointerRNA *ptr, AnimData *adt) * * 3) Drivers/expressions are evaluated on top of this, in an order where dependencies are * resolved nicely. - * Note: it may be necessary to have some tools to handle the cases where some higher-level + * NOTE: it may be necessary to have some tools to handle the cases where some higher-level * drivers are added and cause some problematic dependencies that * didn't exist in the local levels... * diff --git a/source/blender/blenkernel/intern/anim_visualization.c b/source/blender/blenkernel/intern/anim_visualization.c index ecd71ec08fe..56bd8e769bc 100644 --- a/source/blender/blenkernel/intern/anim_visualization.c +++ b/source/blender/blenkernel/intern/anim_visualization.c @@ -50,8 +50,8 @@ void animviz_settings_init(bAnimVizSettings *avs) /* path settings */ avs->path_bc = avs->path_ac = 10; - avs->path_sf = 1; /* xxx - take from scene instead? */ - avs->path_ef = 250; /* xxx - take from scene instead? */ + avs->path_sf = 1; /* XXX: Take from scene instead? */ + avs->path_ef = 250; /* XXX: Take from scene instead? */ avs->path_viewflag = (MOTIONPATH_VIEW_KFRAS | MOTIONPATH_VIEW_KFNOS); diff --git a/source/blender/blenkernel/intern/armature.c b/source/blender/blenkernel/intern/armature.c index d0604f4bfda..22d6cfba893 100644 --- a/source/blender/blenkernel/intern/armature.c +++ b/source/blender/blenkernel/intern/armature.c @@ -2405,9 +2405,9 @@ static void pose_proxy_sync(Object *ob, Object *from, int layer_protected) BKE_pose_rest(frompose, false); /* copy over all of the proxy's bone groups */ - /* TODO for later + /* TODO: for later * - implement 'local' bone groups as for constraints - * Note: this isn't trivial, as bones reference groups by index not by pointer, + * NOTE: this isn't trivial, as bones reference groups by index not by pointer, * so syncing things correctly needs careful attention */ BLI_freelistN(&pose->agroups); BLI_duplicatelist(&pose->agroups, &frompose->agroups); @@ -2543,7 +2543,7 @@ static int rebuild_pose_bone( * (grand-(grand-(...)))-child (as processed by the recursive, depth-first nature of this * function) of the previous sibling. * - * Note: In most cases there is nothing to do here, but pose list may get out of order when some + * NOTE: In most cases there is nothing to do here, but pose list may get out of order when some * bones are added, removed or moved in the armature data. */ bPoseChannel *pchan_prev = pchan->prev; const Bone *last_visited_bone = *r_last_visited_bone_p; diff --git a/source/blender/blenkernel/intern/bpath.c b/source/blender/blenkernel/intern/bpath.c index f26a9f06697..70274de8bff 100644 --- a/source/blender/blenkernel/intern/bpath.c +++ b/source/blender/blenkernel/intern/bpath.c @@ -18,7 +18,7 @@ * \ingroup bli */ -/* TODO, +/* TODO: * currently there are some cases we don't support. * - passing output paths to the visitor?, like render out. * - passing sequence strips with many images. diff --git a/source/blender/blenkernel/intern/brush.c b/source/blender/blenkernel/intern/brush.c index fdf9cf21b85..abf7bab7612 100644 --- a/source/blender/blenkernel/intern/brush.c +++ b/source/blender/blenkernel/intern/brush.c @@ -379,10 +379,10 @@ static void brush_undo_preserve(BlendLibReader *reader, ID *id_new, ID *id_old) BKE_lib_id_swap(NULL, id_new, id_old); /* `id_new` now has content from `id_old`, we need to ensure those old ID pointers are valid. - * Note: Since we want to re-use all old pointers here, code is much simpler than for Scene. */ + * NOTE: Since we want to re-use all old pointers here, code is much simpler than for Scene. */ BKE_library_foreach_ID_link(NULL, id_new, brush_undo_preserve_cb, reader, IDWALK_NOP); - /* Note: We do not swap IDProperties, as dealing with potential ID pointers in those would be + /* NOTE: We do not swap IDProperties, as dealing with potential ID pointers in those would be * fairly delicate. */ SWAP(IDProperty *, id_new->properties, id_old->properties); } diff --git a/source/blender/blenkernel/intern/bvhutils.cc b/source/blender/blenkernel/intern/bvhutils.cc index 3dea49d1953..0284b20d98e 100644 --- a/source/blender/blenkernel/intern/bvhutils.cc +++ b/source/blender/blenkernel/intern/bvhutils.cc @@ -704,7 +704,7 @@ BVHTree *bvhtree_from_editmesh_verts( } /** - * Builds a bvh tree where nodes are the given vertices (note: does not copy given `vert`!). + * Builds a bvh tree where nodes are the given vertices (NOTE: does not copy given `vert`!). * \param vert_allocated: if true, vert freeing will be done when freeing data. * \param verts_mask: if not null, true elements give which vert to add to BVH tree. * \param verts_num_active: if >= 0, number of active verts to add to BVH tree @@ -1051,7 +1051,7 @@ static void bvhtree_from_mesh_faces_setup_data(BVHTreeFromMesh *data, /** * Builds a bvh tree where nodes are the given tessellated faces - * (note: does not copy given mfaces!). + * (NOTE: does not copy given mfaces!). * \param vert_allocated: if true, vert freeing will be done when freeing data. * \param face_allocated: if true, face freeing will be done when freeing data. * \param faces_mask: if not null, true elements give which faces to add to BVH tree. diff --git a/source/blender/blenkernel/intern/cdderivedmesh.c b/source/blender/blenkernel/intern/cdderivedmesh.c index 879313783d9..039a971fe2c 100644 --- a/source/blender/blenkernel/intern/cdderivedmesh.c +++ b/source/blender/blenkernel/intern/cdderivedmesh.c @@ -289,7 +289,7 @@ static DerivedMesh *cdDM_from_mesh_ex(Mesh *mesh, if (mesh->runtime.cd_dirty_vert & CD_MASK_NORMAL) { dm->dirty |= DM_DIRTY_NORMALS; } - /* TODO DM_DIRTY_TESS_CDLAYERS ? Maybe not though, + /* TODO: DM_DIRTY_TESS_CDLAYERS ? Maybe not though, * since we probably want to switch to looptris? */ CustomData_merge(&mesh->vdata, &dm->vertData, cddata_masks.vmask, alloctype, mesh->totvert); diff --git a/source/blender/blenkernel/intern/cloth.c b/source/blender/blenkernel/intern/cloth.c index 09bd397cc78..80e66b452b0 100644 --- a/source/blender/blenkernel/intern/cloth.c +++ b/source/blender/blenkernel/intern/cloth.c @@ -991,7 +991,7 @@ static void cloth_hair_update_bending_targets(ClothModifierData *clmd) return; } - /* XXX Note: we need to propagate frames from the root up, + /* XXX NOTE: we need to propagate frames from the root up, * but structural hair springs are stored in reverse order. * The bending springs however are then inserted in the same * order as vertices again ... @@ -1049,7 +1049,7 @@ static void cloth_hair_update_bending_rest_targets(ClothModifierData *clmd) return; } - /* XXX Note: we need to propagate frames from the root up, + /* XXX NOTE: we need to propagate frames from the root up, * but structural hair springs are stored in reverse order. * The bending springs however are then inserted in the same * order as vertices again ... @@ -1883,7 +1883,7 @@ static bool cloth_build_springs(ClothModifierData *clmd, Mesh *mesh) cloth_hair_update_bending_rest_targets(clmd); } - /* note: the edges may already exist so run reinsert */ + /* NOTE: the edges may already exist so run reinsert. */ /* insert other near springs in edgeset AFTER bending springs are calculated (for selfcolls) */ for (int i = 0; i < numedges; i++) { /* struct springs */ diff --git a/source/blender/blenkernel/intern/collection.c b/source/blender/blenkernel/intern/collection.c index 24266dc6bea..39698bde622 100644 --- a/source/blender/blenkernel/intern/collection.c +++ b/source/blender/blenkernel/intern/collection.c @@ -115,7 +115,7 @@ static void collection_copy_data(Main *bmain, ID *id_dst, const ID *id_src, cons ((collection_src->id.flag & LIB_EMBEDDED_DATA) != 0)); /* Do not copy collection's preview (same behavior as for objects). */ - if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0 && false) { /* XXX TODO temp hack */ + if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0 && false) { /* XXX TODO: temp hack. */ BKE_previewimg_id_copy(&collection_dst->id, &collection_src->id); } else { @@ -1706,7 +1706,7 @@ void BKE_main_collections_parent_relations_rebuild(Main *bmain) for (Collection *collection = bmain->collections.first; collection != NULL; collection = collection->id.next) { if (collection->tag & COLLECTION_TAG_RELATION_REBUILD) { - /* Note: we do not have easy access to 'which collections is root' info in that case, which + /* NOTE: we do not have easy access to 'which collections is root' info in that case, which * means test for cycles in collection relationships may fail here. I don't think that is an * issue in practice here, but worth keeping in mind... */ collection_parents_rebuild_recursive(collection); @@ -1896,7 +1896,7 @@ static void layer_collection_flags_restore_recursive(LayerCollection *layer_coll * and now we moved a new collection to be part of the background this collection should * probably be disabled. * - * Note: If we were to also keep the exclude flag we would need to re-sync the collections. + * NOTE: If we were to also keep the exclude flag we would need to re-sync the collections. */ layer_collection->flag = flag->flag | (layer_collection->flag & LAYER_COLLECTION_EXCLUDE); } @@ -2203,8 +2203,8 @@ void BKE_scene_objects_iterator_end(BLI_Iterator *iter) * Generate a new GSet (or extend given `objects_gset` if not NULL) with all objects referenced by * all collections of given `scene`. * - * \note: This will include objects without a base currently (because they would belong to excluded - * collections only e.g.). + * \note This will include objects without a base currently + * (because they would belong to excluded collections only e.g.). */ GSet *BKE_scene_objects_as_gset(Scene *scene, GSet *objects_gset) { diff --git a/source/blender/blenkernel/intern/colorband.c b/source/blender/blenkernel/intern/colorband.c index d6b318caa5e..52a599a0361 100644 --- a/source/blender/blenkernel/intern/colorband.c +++ b/source/blender/blenkernel/intern/colorband.c @@ -295,7 +295,7 @@ void BKE_colorband_init_from_table_rgba(ColorBand *coba, const int array_len, bool filter_samples) { - /* Note, we could use MAXCOLORBAND here, but results of re-sampling are nicer, + /* NOTE: we could use MAXCOLORBAND here, but results of re-sampling are nicer, * avoid different behavior when limit is hit. */ if (array_len < 2) { /* No Re-sample, just de-duplicate. */ @@ -420,7 +420,7 @@ bool BKE_colorband_evaluate(const ColorBand *coba, float in, float out[4]) cbd1 = coba->data; - /* Note: when ipotype >= COLBAND_INTERP_B_SPLINE, + /* NOTE: when ipotype >= COLBAND_INTERP_B_SPLINE, * we cannot do early-out with a constant color before first color stop and after last one, * because interpolation starts before and ends after those... */ ipotype = (coba->color_mode == COLBAND_BLEND_RGB) ? coba->ipotype : COLBAND_INTERP_LINEAR; diff --git a/source/blender/blenkernel/intern/colortools.c b/source/blender/blenkernel/intern/colortools.c index 1484021cb9d..d46a7865998 100644 --- a/source/blender/blenkernel/intern/colortools.c +++ b/source/blender/blenkernel/intern/colortools.c @@ -873,7 +873,7 @@ static int sort_curvepoints(const void *a1, const void *a2) /* ************************ more CurveMapping calls *************** */ -/* note; only does current curvemap! */ +/* NOTE: only does current curvemap! */ void BKE_curvemapping_changed(CurveMapping *cumap, const bool rem_doubles) { CurveMap *cuma = cumap->cm + cumap->cur; @@ -1267,9 +1267,9 @@ void BKE_curvemapping_blend_read(BlendDataReader *reader, CurveMapping *cumap) BLI_INLINE int get_bin_float(float f) { - int bin = (int)((f * 255.0f) + 0.5f); /* 0.5 to prevent quantisation differences */ + int bin = (int)((f * 255.0f) + 0.5f); /* 0.5 to prevent quantization differences */ - /* note: clamp integer instead of float to avoid problems with NaN */ + /* NOTE: clamp integer instead of float to avoid problems with NaN. */ CLAMP(bin, 0, 255); return bin; diff --git a/source/blender/blenkernel/intern/constraint.c b/source/blender/blenkernel/intern/constraint.c index fe207f81d7d..bc993d8d58d 100644 --- a/source/blender/blenkernel/intern/constraint.c +++ b/source/blender/blenkernel/intern/constraint.c @@ -927,7 +927,7 @@ static void default_get_tarmat_full_bbone(struct Depsgraph *UNUSED(depsgraph), /* This following macro should be used for all standard single-target *_flush_tars functions * to save typing and reduce maintenance woes. - * Note: the pointer to ct will be changed to point to the next in the list (as it gets removed) + * NOTE: the pointer to ct will be changed to point to the next in the list (as it gets removed) * (Hopefully all compilers will be happy with the lines with just a space on them. Those are * really just to help this code easier to read) */ @@ -949,7 +949,7 @@ static void default_get_tarmat_full_bbone(struct Depsgraph *UNUSED(depsgraph), /* This following macro should be used for all standard single-target *_flush_tars functions * to save typing and reduce maintenance woes. It does not do the subtarget related operations. - * Note: the pointer to ct will be changed to point to the next in the list (as it gets removed) + * NOTE: the pointer to ct will be changed to point to the next in the list (as it gets removed) * (Hopefully all compilers will be happy with the lines with just a space on them. Those are * really just to help this code easier to read) */ @@ -1148,7 +1148,7 @@ static void childof_evaluate(bConstraint *con, bConstraintOb *cob, ListBase *tar } } -/* XXX note, con->flag should be CONSTRAINT_SPACEONCE for bone-childof, patched in readfile.c */ +/* XXX NOTE: con->flag should be CONSTRAINT_SPACEONCE for bone-childof, patched in `readfile.c`. */ static bConstraintTypeInfo CTI_CHILDOF = { CONSTRAINT_TYPE_CHILDOF, /* type */ sizeof(bChildOfConstraint), /* size */ @@ -1265,7 +1265,7 @@ static void vectomat(const float vec[3], u[2] = 1; } - /* note: even though 'n' is normalized, don't use 'project_v3_v3v3_normalized' below + /* NOTE: even though 'n' is normalized, don't use 'project_v3_v3v3_normalized' below * because precision issues cause a problem in near degenerate states, see: T53455. */ /* project the up vector onto the plane specified by n */ @@ -1519,7 +1519,7 @@ static void followpath_get_tarmat(struct Depsgraph *UNUSED(depsgraph), unit_m4(ct->matrix); - /* note: when creating constraints that follow path, the curve gets the CU_PATH set now, + /* NOTE: when creating constraints that follow path, the curve gets the CU_PATH set now, * currently for paths to work it needs to go through the bevlist/displist system (ton) */ @@ -1603,8 +1603,8 @@ static void followpath_evaluate(bConstraint *con, bConstraintOb *cob, ListBase * /* un-apply scaling caused by path */ if ((data->followflag & FOLLOWPATH_RADIUS) == 0) { - /* XXX: Assume that scale correction means that radius - * will have some scale error in it - Campbell. */ + /* XXX(campbell): Assume that scale correction means that radius + * will have some scale error in it. */ float obsize[3]; mat4_to_size(obsize, cob->matrix); @@ -3881,7 +3881,7 @@ static void clampto_evaluate(bConstraint *con, bConstraintOb *cob, ListBase *tar unit_m4(targetMatrix); INIT_MINMAX(curveMin, curveMax); - /* XXX - don't think this is good calling this here - campbell */ + /* XXX(campbell): don't think this is good calling this here. */ BKE_object_minmax(ct->tar, curveMin, curveMax, true); /* get targetmatrix */ @@ -4332,7 +4332,7 @@ static void shrinkwrap_get_tarmat(struct Depsgraph *UNUSED(depsgraph), float mat[4][4]; float no[3] = {0.0f, 0.0f, 0.0f}; - /* TODO should use FLT_MAX.. but normal projection doenst yet supports it */ + /* TODO: should use FLT_MAX.. but normal projection doesn't yet supports it. */ hit.index = -1; hit.dist = (scon->projLimit == 0.0f) ? BVH_RAYCAST_DIST_MAX : scon->projLimit; @@ -6359,7 +6359,7 @@ void BKE_constraints_solve(struct Depsgraph *depsgraph, * (T26014 and T25725), since some constraints may not convert the solution back to the input * space before blending but all are guaranteed to end up in good "world-space" result. */ - /* Note: all kind of stuff here before (caused trouble), much easier to just interpolate, + /* NOTE: all kind of stuff here before (caused trouble), much easier to just interpolate, * or did I miss something? -jahka (r.32105) */ if (enf < 1.0f) { float solution[4][4]; diff --git a/source/blender/blenkernel/intern/curve.c b/source/blender/blenkernel/intern/curve.c index a5538453248..24615dd8c2b 100644 --- a/source/blender/blenkernel/intern/curve.c +++ b/source/blender/blenkernel/intern/curve.c @@ -2123,8 +2123,8 @@ static void tilt_bezpart(const BezTriple *prevbezt, if (radius_array) { if (nu->radius_interp == KEY_CU_EASE) { /* Support 2.47 ease interp - * Note! - this only takes the 2 points into account, - * giving much more localized results to changes in radius, sometimes you want that */ + * NOTE: this only takes the 2 points into account, + * giving much more localized results to changes in radius, sometimes you want that. */ *radius_array = prevbezt->radius + (bezt->radius - prevbezt->radius) * (3.0f * fac * fac - 2.0f * fac * fac * fac); } @@ -2490,7 +2490,7 @@ static void make_bevel_list_3D_tangent(BevList *bl) cross_v3_v3v3(cross_tmp, bevp1->tan, bevp1->dir); normalize_v3(cross_tmp); - tri_to_quat(bevp1->quat, zero, cross_tmp, bevp1->tan); /* XXX - could be faster */ + tri_to_quat(bevp1->quat, zero, cross_tmp, bevp1->tan); /* XXX: could be faster. */ /* bevp0 = bevp1; */ /* UNUSED */ bevp1 = bevp2; @@ -2559,8 +2559,8 @@ static void make_bevel_list_segment_2D(BevList *bl) static void make_bevel_list_2D(BevList *bl) { - /* note: bevp->dir and bevp->quat are not needed for beveling but are - * used when making a path from a 2D curve, therefore they need to be set - Campbell */ + /* NOTE(campbell): `bevp->dir` and `bevp->quat` are not needed for beveling but are + * used when making a path from a 2D curve, therefore they need to be set. */ BevPoint *bevp0, *bevp1, *bevp2; int nr; @@ -3658,7 +3658,7 @@ static bool tridiagonal_solve_with_limits(float *a, * is affected by all other points of the curve segment, in practice the influence * decreases exponentially with distance. * - * Note: this algorithm assumes that the handle horizontal size is always 1/3 of the + * NOTE: this algorithm assumes that the handle horizontal size is always 1/3 of the * of the interval to the next point. This rule ensures linear interpolation of time. * * ^ height (co 1) diff --git a/source/blender/blenkernel/intern/curve_deform.c b/source/blender/blenkernel/intern/curve_deform.c index 7deac4e4f19..28b7c2dfba0 100644 --- a/source/blender/blenkernel/intern/curve_deform.c +++ b/source/blender/blenkernel/intern/curve_deform.c @@ -168,7 +168,7 @@ static bool calc_curve_deform( * * Now for Neg Up XYZ, the colors are all dark, and ordered clockwise - Campbell * - * note: moved functions into quat_apply_track/vec_apply_track + * NOTE: moved functions into quat_apply_track/vec_apply_track */ copy_qt_qt(quat, new_quat); copy_v3_v3(cent, co); diff --git a/source/blender/blenkernel/intern/customdata.c b/source/blender/blenkernel/intern/customdata.c index 08d0af45e92..4c0849d18de 100644 --- a/source/blender/blenkernel/intern/customdata.c +++ b/source/blender/blenkernel/intern/customdata.c @@ -105,8 +105,10 @@ typedef struct LayerTypeInfo { /** * default layer name. - * note! when NULL this is a way to ensure there is only ever one item - * see: CustomData_layertype_is_singleton() */ + * + * \note when NULL this is a way to ensure there is only ever one item + * see: CustomData_layertype_is_singleton(). + */ const char *defaultname; /** @@ -329,7 +331,7 @@ static void layerInterp_normal(const void **sources, int count, void *dest) { - /* Note: This is linear interpolation, which is not optimal for vectors. + /* NOTE: This is linear interpolation, which is not optimal for vectors. * Unfortunately, spherical interpolation of more than two values is hairy, * so for now it will do... */ float no[3] = {0.0f}; @@ -1594,7 +1596,7 @@ static const LayerTypeInfo LAYERTYPEINFO[CD_NUMTYPES] = { /* 14: CD_ORCO */ {sizeof(float[3]), "", 0, NULL, NULL, NULL, NULL, NULL, NULL}, /* 15: CD_MTEXPOLY */ /* DEPRECATED */ - /* note, when we expose the UV Map / TexFace split to the user, + /* NOTE: when we expose the UV Map / TexFace split to the user, * change this back to face Texture. */ {sizeof(int), "", 0, NULL, NULL, NULL, NULL, NULL, NULL}, /* 16: CD_MLOOPUV */ @@ -3805,7 +3807,7 @@ void *CustomData_bmesh_get_n(const CustomData *data, void *block, int type, int return POINTER_OFFSET(block, data->layers[layer_index + n].offset); } -/* Gets from the layer at physical index n, note: doesn't check type. */ +/* Gets from the layer at physical index n, NOTE: doesn't check type. */ void *CustomData_bmesh_get_layer_n(const CustomData *data, void *block, int n) { if (n < 0 || n >= data->totlayer) { @@ -4974,7 +4976,7 @@ void CustomData_data_transfer(const MeshPairRemap *me_remap, size_t tmp_buff_size = 32; const void **tmp_data_src = NULL; - /* Note: NULL data_src may happen and be valid (see vgroups...). */ + /* NOTE: NULL data_src may happen and be valid (see vgroups...). */ if (!data_dst) { return; } @@ -4991,7 +4993,7 @@ void CustomData_data_transfer(const MeshPairRemap *me_remap, else { const LayerTypeInfo *type_info = layerType_getInfo(data_type); - /* Note: we can use 'fake' CDLayers, like e.g. for crease, bweight, etc. :/ */ + /* NOTE: we can use 'fake' CDLayers, like e.g. for crease, bweight, etc. :/. */ data_size = (size_t)type_info->size; data_step = laymap->elem_size ? laymap->elem_size : data_size; data_offset = laymap->data_offset; diff --git a/source/blender/blenkernel/intern/data_transfer.c b/source/blender/blenkernel/intern/data_transfer.c index 12269cf0d51..aec849ebf59 100644 --- a/source/blender/blenkernel/intern/data_transfer.c +++ b/source/blender/blenkernel/intern/data_transfer.c @@ -691,7 +691,7 @@ static bool data_transfer_layersmapping_cdlayers_multisrc_to_dst(ListBase *r_map } if (data_dst_to_delete) { - /* Note: + /* NOTE: * This won't affect newly created layers, if any, since tot_dst has not been updated! * Also, looping backward ensures us we do not suffer * from index shifting when deleting a layer. */ @@ -764,7 +764,7 @@ static bool data_transfer_layersmapping_cdlayers(ListBase *r_map, } } else if (fromlayers == DT_LAYERS_ACTIVE_SRC || fromlayers >= 0) { - /* Note: use_delete has not much meaning in this case, ignored. */ + /* NOTE: use_delete has not much meaning in this case, ignored. */ if (fromlayers >= 0) { /* Real-layer index */ idx_src = fromlayers; diff --git a/source/blender/blenkernel/intern/deform.c b/source/blender/blenkernel/intern/deform.c index e6ef569d4b9..19840a70bf0 100644 --- a/source/blender/blenkernel/intern/deform.c +++ b/source/blender/blenkernel/intern/deform.c @@ -716,7 +716,7 @@ MDeformWeight *BKE_defvert_ensure_index(MDeformVert *dvert, const int defgroup) return dw_new; } -/* TODO. merge with code above! */ +/* TODO: merge with code above! */ /** * Adds the given vertex to the specified vertex group, with given weight. @@ -1334,7 +1334,7 @@ bool data_transfer_layersmapping_vgroups(ListBase *r_map, const size_t elem_size = sizeof(*((MDeformVert *)NULL)); - /* Note: + /* NOTE: * VGroups are a bit hairy, since their layout is defined on object level (ob->defbase), * while their actual data is a (mesh) CD layer. * This implies we may have to handle data layout itself while having NULL data itself, @@ -1357,7 +1357,7 @@ bool data_transfer_layersmapping_vgroups(ListBase *r_map, } if (fromlayers == DT_LAYERS_ACTIVE_SRC || fromlayers >= 0) { - /* Note: use_delete has not much meaning in this case, ignored. */ + /* NOTE: use_delete has not much meaning in this case, ignored. */ if (fromlayers >= 0) { idx_src = fromlayers; @@ -1373,7 +1373,7 @@ bool data_transfer_layersmapping_vgroups(ListBase *r_map, } if (tolayers >= 0) { - /* Note: in this case we assume layer exists! */ + /* NOTE: in this case we assume layer exists! */ idx_dst = tolayers; BLI_assert(idx_dst < BLI_listbase_count(&ob_dst->defbase)); } diff --git a/source/blender/blenkernel/intern/displist_tangent.c b/source/blender/blenkernel/intern/displist_tangent.c index 88fef1a4cfd..5c969d52aea 100644 --- a/source/blender/blenkernel/intern/displist_tangent.c +++ b/source/blender/blenkernel/intern/displist_tangent.c @@ -171,7 +171,7 @@ static void dlsurf_ts_GetTextureCoordinate(const SMikkTSpaceContext *pContext, int idx = face_to_vert_index(dlt, face_num, vert_index); - /* Note: For some reason the shading U and V are swapped compared to the + /* NOTE: For some reason the shading U and V are swapped compared to the * one described in the surface format. */ r_uv[0] = (idx / dlt->dl->nr) / (float)(dlt->v_len); r_uv[1] = (idx % dlt->dl->nr) / (float)(dlt->u_len); diff --git a/source/blender/blenkernel/intern/dynamicpaint.c b/source/blender/blenkernel/intern/dynamicpaint.c index 2eb18a06799..396ba01c71f 100644 --- a/source/blender/blenkernel/intern/dynamicpaint.c +++ b/source/blender/blenkernel/intern/dynamicpaint.c @@ -2288,7 +2288,8 @@ static void dynamic_paint_create_uv_surface_direct_cb( /* Loop through samples, starting from middle point */ for (int sample = 0; sample < 5; sample++) { /* Loop through every face in the mesh */ - /* XXX TODO This is *horrible* with big meshes, should use a 2D BVHTree over UV tris here! */ + /* XXX TODO: This is *horrible* with big meshes, should use a 2D BVHTree over UV tris here! + */ for (int i = 0; i < tottri; i++) { /* Check uv bb */ if ((faceBB[i].min[0] > point[sample][0]) || (faceBB[i].min[1] > point[sample][1]) || @@ -2476,7 +2477,7 @@ static int dynamic_paint_find_neighbor_pixel(const DynamicPaintCreateUVSurfaceDa const int py, const int n_index) { - /* Note: Current method only uses polygon edges to detect neighboring pixels. + /* NOTE: Current method only uses polygon edges to detect neighboring pixels. * -> It doesn't always lead to the optimum pixel but is accurate enough * and faster/simpler than including possible face tip point links) */ @@ -4190,8 +4191,8 @@ static void dynamic_paint_paint_mesh_cell_point_cb_ex( /* calculate barycentric weights for hit point */ interp_weights_tri_v3(weights, mvert[v1].co, mvert[v2].co, mvert[v3].co, hitCoord); - /* simple check based on brush surface velocity, - * todo: perhaps implement something that handles volume movement as well. */ + /* Simple check based on brush surface velocity, + * TODO: perhaps implement something that handles volume movement as well. */ /* interpolate vertex speed vectors to get hit point velocity */ interp_v3_v3v3v3(brushPointVelocity, @@ -4881,7 +4882,7 @@ static void dynamicPaint_prepareAdjacencyData(DynamicPaintSurface *surface, cons 0, sData->total_points, sData, dynamic_paint_prepare_adjacency_cb, &settings); /* calculate average values (single thread). - * Note: tried to put this in threaded callback (using _reduce feature), + * NOTE: tried to put this in threaded callback (using _reduce feature), * but gave ~30% slower result! */ bData->average_dist = 0.0; for (index = 0; index < sData->total_points; index++) { diff --git a/source/blender/blenkernel/intern/editmesh.c b/source/blender/blenkernel/intern/editmesh.c index 49c2a2cbd89..2eb6b488da2 100644 --- a/source/blender/blenkernel/intern/editmesh.c +++ b/source/blender/blenkernel/intern/editmesh.c @@ -330,7 +330,7 @@ void BKE_editmesh_lnorspace_update(BMEditMesh *em, Mesh *me) * otherwise there is no way to edit them. * Similar code to #MESH_OT_customdata_custom_splitnormals_add operator, * we want to keep same shading in case we were using auto-smooth so far. - * Note: there is a problem here, which is that if someone starts a normal editing operation on + * NOTE: there is a problem here, which is that if someone starts a normal editing operation on * previously auto-smooth-ed mesh, and cancel that operation, generated CLNORS data remain, * with related sharp edges (and hence auto-smooth is 'lost'). * Not sure how critical this is, and how to fix that issue? */ diff --git a/source/blender/blenkernel/intern/editmesh_bvh.c b/source/blender/blenkernel/intern/editmesh_bvh.c index 9e0e1933a00..087481b1b5d 100644 --- a/source/blender/blenkernel/intern/editmesh_bvh.c +++ b/source/blender/blenkernel/intern/editmesh_bvh.c @@ -117,7 +117,7 @@ BMBVHTree *BKE_bmbvh_new_ex(BMesh *bm, for (int i = 0; i < looptris_tot; i++) { if (test_fn) { - /* Note: the arrays won't align now! Take care. */ + /* NOTE: the arrays won't align now! Take care. */ f_test = looptris[i][0]->f; if (f_test != f_test_prev) { test_fn_ret = test_fn(f_test, user_data); diff --git a/source/blender/blenkernel/intern/editmesh_tangent.c b/source/blender/blenkernel/intern/editmesh_tangent.c index d849f4ab37d..e5e639fa3f1 100644 --- a/source/blender/blenkernel/intern/editmesh_tangent.c +++ b/source/blender/blenkernel/intern/editmesh_tangent.c @@ -381,7 +381,7 @@ void BKE_editmesh_loop_tangent_calc(BMEditMesh *em, mesh2tangent->num_face_as_quad_map = num_face_as_quad_map; #endif mesh2tangent->precomputedFaceNormals = poly_normals; - /* Note, we assume we do have tessellated loop normals at this point + /* NOTE: we assume we do have tessellated loop normals at this point * (in case it is object-enabled), have to check this is valid. */ mesh2tangent->precomputedLoopNormals = loop_normals; mesh2tangent->cd_loop_uv_offset = CustomData_get_n_offset(&bm->ldata, CD_MLOOPUV, n); diff --git a/source/blender/blenkernel/intern/fcurve.c b/source/blender/blenkernel/intern/fcurve.c index a670e7b9ac5..8f47a7e75d4 100644 --- a/source/blender/blenkernel/intern/fcurve.c +++ b/source/blender/blenkernel/intern/fcurve.c @@ -2147,7 +2147,7 @@ static float fcurve_eval_samples(FCurve *fcu, FPoint *fpts, float evaltime) * \{ */ /* Evaluate and return the value of the given F-Curve at the specified frame ("evaltime") - * Note: this is also used for drivers. + * NOTE: this is also used for drivers. */ static float evaluate_fcurve_ex(FCurve *fcu, float evaltime, float cvalue) { diff --git a/source/blender/blenkernel/intern/fmodifier.c b/source/blender/blenkernel/intern/fmodifier.c index b9f0b97ab46..dbd48005e9e 100644 --- a/source/blender/blenkernel/intern/fmodifier.c +++ b/source/blender/blenkernel/intern/fmodifier.c @@ -604,7 +604,7 @@ int BKE_fcm_envelope_find_index(FCM_EnvelopeData array[], * NOTE: this needs to be at the start of the stack to be of use, * as it needs to know the extents of the keyframes/sample-data. * - * Possible TODO - store length of cycle information that can be initialized from the extents of + * Possible TODO: store length of cycle information that can be initialized from the extents of * the keyframes/sample-data, and adjusted as appropriate. */ diff --git a/source/blender/blenkernel/intern/font.c b/source/blender/blenkernel/intern/font.c index 8bb2c401b03..d0b9aeefa55 100644 --- a/source/blender/blenkernel/intern/font.c +++ b/source/blender/blenkernel/intern/font.c @@ -984,7 +984,7 @@ static bool vfont_to_curve(Object *ob, } if (dobreak) { if (tb_scale.h == 0.0f) { - /* Note: If underlined text is truncated away, the extra space is also truncated. */ + /* NOTE: If underlined text is truncated away, the extra space is also truncated. */ custrinfo[i + 1].flag |= CU_CHINFO_OVERFLOW; } goto makebreak; @@ -1032,7 +1032,7 @@ static bool vfont_to_curve(Object *ob, current_line_length = 0.0f; } - /* XXX, has been unused for years, need to check if this is useful, r4613 r5282 - campbell */ + /* XXX(campbell): has been unused for years, need to check if this is useful, r4613 r5282. */ #if 0 if (ascii == '\n') { xof = xof_scale; diff --git a/source/blender/blenkernel/intern/gpencil.c b/source/blender/blenkernel/intern/gpencil.c index 459fc5e4c68..61307e1a354 100644 --- a/source/blender/blenkernel/intern/gpencil.c +++ b/source/blender/blenkernel/intern/gpencil.c @@ -92,7 +92,7 @@ static void greasepencil_copy_data(Main *UNUSED(bmain), LISTBASE_FOREACH (bGPDlayer *, gpl_src, &gpd_src->layers) { /* make a copy of source layer and its data */ - /* TODO here too could add unused flags... */ + /* TODO: here too could add unused flags... */ bGPDlayer *gpl_dst = BKE_gpencil_layer_duplicate(gpl_src, true, true); /* Apply local layer transform to all frames. Calc the active frame is not enough diff --git a/source/blender/blenkernel/intern/gpencil_geom.c b/source/blender/blenkernel/intern/gpencil_geom.c index 077c1a65243..426e880e266 100644 --- a/source/blender/blenkernel/intern/gpencil_geom.c +++ b/source/blender/blenkernel/intern/gpencil_geom.c @@ -3561,7 +3561,7 @@ void BKE_gpencil_stroke_uniform_subdivide(bGPdata *gpd, * Stroke to view space * Transforms a stroke to view space. This allows for manipulations in 2D but also easy conversion * back to 3D. - * Note: also takes care of parent space transform + * NOTE: also takes care of parent space transform */ void BKE_gpencil_stroke_to_view_space(RegionView3D *rv3d, bGPDstroke *gps, @@ -3580,7 +3580,7 @@ void BKE_gpencil_stroke_to_view_space(RegionView3D *rv3d, * Stroke from view space * Transforms a stroke from view space back to world space. Inverse of * BKE_gpencil_stroke_to_view_space - * Note: also takes care of parent space transform + * NOTE: also takes care of parent space transform */ void BKE_gpencil_stroke_from_view_space(RegionView3D *rv3d, bGPDstroke *gps, diff --git a/source/blender/blenkernel/intern/gpencil_modifier.c b/source/blender/blenkernel/intern/gpencil_modifier.c index 9f5f70ab2ba..4d9c9878a67 100644 --- a/source/blender/blenkernel/intern/gpencil_modifier.c +++ b/source/blender/blenkernel/intern/gpencil_modifier.c @@ -350,7 +350,7 @@ GpencilModifierData *BKE_gpencil_modifier_new(int type) const GpencilModifierTypeInfo *mti = BKE_gpencil_modifier_get_info(type); GpencilModifierData *md = MEM_callocN(mti->struct_size, mti->struct_name); - /* note, this name must be made unique later */ + /* NOTE: this name must be made unique later. */ BLI_strncpy(md->name, DATA_(mti->name), sizeof(md->name)); md->type = type; diff --git a/source/blender/blenkernel/intern/idprop.c b/source/blender/blenkernel/intern/idprop.c index a67e78ceea0..7a88a00c44f 100644 --- a/source/blender/blenkernel/intern/idprop.c +++ b/source/blender/blenkernel/intern/idprop.c @@ -186,7 +186,7 @@ void IDP_ResizeIDPArray(IDProperty *prop, int newlen) } } - /* - Note: This code comes from python, here's the corresponding comment. - */ + /* NOTE: This code comes from python, here's the corresponding comment. */ /* This over-allocates proportional to the list size, making room * for additional growth. The over-allocation is mild, but is * enough to give linear-time amortized behavior over a long @@ -240,7 +240,7 @@ void IDP_ResizeArray(IDProperty *prop, int newlen) return; } - /* - Note: This code comes from python, here's the corresponding comment. - */ + /* NOTE: This code comes from python, here's the corresponding comment. */ /* This over-allocates proportional to the list size, making room * for additional growth. The over-allocation is mild, but is * enough to give linear-time amortized behavior over a long @@ -942,7 +942,7 @@ IDProperty *IDP_New(const char type, const IDPropertyTemplate *val, const char * prop = MEM_callocN(sizeof(IDProperty), "IDProperty string"); if (val->string.subtype == IDP_STRING_SUB_BYTE) { - /* note, intentionally not null terminated */ + /* NOTE: Intentionally not null terminated. */ if (st == NULL) { prop->data.pointer = MEM_mallocN(DEFAULT_ALLOC_FOR_NULL_STRINGS, "id property string 1"); *IDP_String(prop) = '\0'; @@ -1183,7 +1183,7 @@ static void IDP_DirectLinkIDPArray(IDProperty *prop, BlendDataReader *reader) IDProperty *array = (IDProperty *)prop->data.pointer; - /* note!, idp-arrays didn't exist in 2.4x, so the pointer will be cleared + /* NOTE:, idp-arrays didn't exist in 2.4x, so the pointer will be cleared * there's not really anything we can do to correct this, at least don't crash */ if (array == NULL) { prop->len = 0; @@ -1274,7 +1274,7 @@ static void IDP_DirectLinkProperty(IDProperty *prop, BlendDataReader *reader) * IDP are way too polymorphic to do it safely. */ printf( "%s: found unknown IDProperty type %d, reset to Integer one !\n", __func__, prop->type); - /* Note: we do not attempt to free unknown prop, we have no way to know how to do that! */ + /* NOTE: we do not attempt to free unknown prop, we have no way to know how to do that! */ prop->type = IDP_INT; prop->subtype = 0; IDP_Int(prop) = 0; diff --git a/source/blender/blenkernel/intern/idprop_utils.c b/source/blender/blenkernel/intern/idprop_utils.c index 433f0e97844..0cc212e1880 100644 --- a/source/blender/blenkernel/intern/idprop_utils.c +++ b/source/blender/blenkernel/intern/idprop_utils.c @@ -96,7 +96,7 @@ static void idp_str_append_escape(struct ReprState *state, static void idp_repr_fn_recursive(struct ReprState *state, const IDProperty *prop) { - /* Note: 'strlen' will be calculated at compile time for literals. */ + /* NOTE: 'strlen' will be calculated at compile time for literals. */ #define STR_APPEND_STR(str) state->str_append_fn(state->user_data, str, (uint)strlen(str)) #define STR_APPEND_STR_QUOTE(str) idp_str_append_escape(state, str, (uint)strlen(str), true) diff --git a/source/blender/blenkernel/intern/image.c b/source/blender/blenkernel/intern/image.c index 740c9b3864c..9eee6231ebf 100644 --- a/source/blender/blenkernel/intern/image.c +++ b/source/blender/blenkernel/intern/image.c @@ -640,7 +640,7 @@ void BKE_image_merge(Main *bmain, Image *dest, Image *source) } } -/* note, we could be clever and scale all imbuf's but since some are mipmaps its not so simple */ +/* NOTE: We could be clever and scale all imbuf's but since some are mipmaps its not so simple. */ bool BKE_image_scale(Image *image, int width, int height) { ImBuf *ibuf; @@ -2323,7 +2323,7 @@ void BKE_image_stamp_buf(Scene *scene, stampdata_from_template(&stamp_data, scene, stamp_data_template, do_prefix); } - /* TODO, do_versions */ + /* TODO: do_versions. */ if (scene->r.stamp_font_id < 8) { scene->r.stamp_font_id = 12; } @@ -2867,7 +2867,7 @@ bool BKE_imbuf_alpha_test(ImBuf *ibuf) return false; } -/* note: imf->planes is ignored here, its assumed the image channels +/* NOTE: imf->planes is ignored here, its assumed the image channels * are already set */ void BKE_imbuf_write_prepare(ImBuf *ibuf, const ImageFormatData *imf) { @@ -4540,7 +4540,7 @@ static ImBuf *load_image_single(Image *ima, } /* warning, 'iuser' can be NULL - * note: Image->views was already populated (in image_update_views_format) + * NOTE: Image->views was already populated (in image_update_views_format) */ static ImBuf *image_load_image_file(Image *ima, ImageUser *iuser, int cfra) { @@ -5391,7 +5391,7 @@ void BKE_image_user_frame_calc(Image *ima, ImageUser *iuser, int cfra) } if (ima && ima->gpuframenr != iuser->framenr) { - /* Note: a single texture and refresh doesn't really work when + /* NOTE: a single texture and refresh doesn't really work when * multiple image users may use different frames, this is to * be improved with perhaps a GPU texture cache. */ ima->gpuflag |= IMA_GPU_REFRESH; diff --git a/source/blender/blenkernel/intern/image_save.c b/source/blender/blenkernel/intern/image_save.c index b68cd9e4d2d..9e3d5a162ae 100644 --- a/source/blender/blenkernel/intern/image_save.c +++ b/source/blender/blenkernel/intern/image_save.c @@ -169,7 +169,7 @@ static bool image_save_single(ReportList *reports, } } else { - /* TODO, better solution, if a 24bit image is painted onto it may contain alpha */ + /* TODO: better solution, if a 24bit image is painted onto it may contain alpha. */ if ((opts->im_format.planes == R_IMF_PLANES_RGBA) && /* it has been painted onto */ (ibuf->userflags & IB_BITMAPDIRTY)) { diff --git a/source/blender/blenkernel/intern/ipo.c b/source/blender/blenkernel/intern/ipo.c index f365e759221..a1f82b1dcb6 100644 --- a/source/blender/blenkernel/intern/ipo.c +++ b/source/blender/blenkernel/intern/ipo.c @@ -1135,7 +1135,7 @@ static char *get_rna_access(ID *id, /* special case for rotdiff drivers... we don't need a property for this... */ break; - /* TODO... add other blocktypes... */ + /* TODO: add other block-types. */ default: CLOG_WARN(&LOG, "No path for blocktype %d, adrcode %d yet", blocktype, adrcode); break; @@ -1162,7 +1162,7 @@ static char *get_rna_access(ID *id, /* 'buf' _must_ be initialized in this block */ /* append preceding bits to path */ - /* note, strings are not escapted and they should be! */ + /* NOTE: strings are not escapted and they should be! */ if ((actname && actname[0]) && (constname && constname[0])) { /* Constraint in Pose-Channel */ char actname_esc[sizeof(((bActionChannel *)NULL)->name) * 2]; @@ -1305,7 +1305,7 @@ static ChannelDriver *idriver_to_cdriver(IpoDriver *idriver) dtar = &dvar->targets[1]; dtar->id = (ID *)idriver->ob; dtar->idtype = ID_OB; - if (idriver->name[0]) { /* xxx... for safety */ + if (idriver->name[0]) { /* XXX: for safety. */ BLI_strncpy( dtar->pchan_name, idriver->name + DRIVER_NAME_OFFS, sizeof(dtar->pchan_name)); } @@ -1358,12 +1358,12 @@ static void fcurve_add_to_list( bActionGroup *agrp = NULL; /* init the temp action */ - memset(&tmp_act, 0, sizeof(bAction)); /* XXX only enable this line if we get errors */ + memset(&tmp_act, 0, sizeof(bAction)); /* XXX: Only enable this line if we get errors. */ tmp_act.groups.first = groups->first; tmp_act.groups.last = groups->last; tmp_act.curves.first = list->first; tmp_act.curves.last = list->last; - /* ... xxx, the other vars don't need to be filled in */ + /* XXX: The other vars don't need to be filled in. */ /* get the group to use */ agrp = BKE_action_group_find_name(&tmp_act, grpname); diff --git a/source/blender/blenkernel/intern/lib_id.c b/source/blender/blenkernel/intern/lib_id.c index 297ee565257..c00fba852ef 100644 --- a/source/blender/blenkernel/intern/lib_id.c +++ b/source/blender/blenkernel/intern/lib_id.c @@ -667,7 +667,7 @@ ID *BKE_id_copy_for_duplicate(Main *bmain, ID *id, const eDupli_ID_Flags duplica ID_NEW_SET(key, key_new); } - /* Note: embedded data (root nodetrees and master collections) should never be referenced by + /* NOTE: embedded data (root nodetrees and master collections) should never be referenced by * anything else, so we do not need to set their newid pointer and flag. */ BKE_animdata_duplicate_id_action(bmain, id_new, duplicate_flags); @@ -1099,7 +1099,7 @@ void *BKE_libblock_alloc(Main *bmain, short type, const char *name, const int fl /* alphabetic insertion: is in new_id */ BKE_main_unlock(bmain); - /* TODO to be removed from here! */ + /* TODO: to be removed from here! */ if ((flag & LIB_ID_CREATE_NO_DEG_TAG) == 0) { DEG_id_type_tag(bmain, type); } @@ -1234,11 +1234,11 @@ void BKE_libblock_copy_ex(Main *bmain, const ID *id, ID **r_newid, const int ori if ((flag & LIB_ID_CREATE_NO_ALLOCATE) != 0) { /* r_newid already contains pointer to allocated memory. */ - /* TODO do we want to memset(0) whole mem before filling it? */ + /* TODO: do we want to memset(0) whole mem before filling it? */ BLI_strncpy(new_id->name, id->name, sizeof(new_id->name)); new_id->us = 0; new_id->tag |= LIB_TAG_NOT_ALLOCATED | LIB_TAG_NO_MAIN | LIB_TAG_NO_USER_REFCOUNT; - /* TODO Do we want/need to copy more from ID struct itself? */ + /* TODO: Do we want/need to copy more from ID struct itself? */ } else { new_id = BKE_libblock_alloc(bmain, GS(id->name), id->name + 2, flag); @@ -1380,7 +1380,7 @@ void id_sort_by_name(ListBase *lb, ID *id, ID *id_sorting_hint) /* Step one: We go backward over a whole chunk of items at once, until we find a limit item * that is lower than, or equal (should never happen!) to the one we want to insert. */ - /* Note: We start from the end, because in typical 'heavy' case (insertion of lots of IDs at + /* NOTE: We start from the end, because in typical 'heavy' case (insertion of lots of IDs at * once using the same base name), newly inserted items will generally be towards the end * (higher extension numbers). */ bool is_in_library = false; @@ -1450,7 +1450,7 @@ void id_sort_by_name(ListBase *lb, ID *id, ID *id_sorting_hint) #undef ID_SORT_STEP_SIZE } -/* Note: this code assumes and ensures that the suffix number can never go beyond 1 billion. */ +/* NOTE: this code assumes and ensures that the suffix number can never go beyond 1 billion. */ #define MAX_NUMBER 1000000000 /* We do not want to get "name.000", so minimal number is 1. */ #define MIN_NUMBER 1 @@ -1605,7 +1605,7 @@ static bool check_for_dupid(ListBase *lb, ID *id, char *name, ID **r_id_sorting_ } /* In case we get an insane initial number suffix in given name. */ - /* Note: BLI_split_name_num() cannot return negative numbers, so we do not have to check for + /* NOTE: BLI_split_name_num() cannot return negative numbers, so we do not have to check for * that here. */ if (number >= MAX_NUMBER || number < MIN_NUMBER) { number = MIN_NUMBER; @@ -1892,7 +1892,7 @@ static void library_make_local_copying_check(ID *id, * \param set_fake: If true, set fake user on all localized data-blocks * (except group and objects ones). */ -/* Note: Old (2.77) version was simply making (tagging) data-blocks as local, +/* NOTE: Old (2.77) version was simply making (tagging) data-blocks as local, * without actually making any check whether they were also indirectly used or not... * * Current version uses regular id_make_local callback, with advanced pre-processing step to @@ -2070,7 +2070,7 @@ void BKE_library_make_local(Main *bmain, * ID in a separated loop, * as lbarray ordering is not enough to ensure us we did catch all dependencies * (e.g. if making local a parent object before its child...). See T48907. */ - /* TODO This is now the biggest step by far (in term of processing time). + /* TODO: This is now the biggest step by far (in term of processing time). * We may be able to gain here by using again main->relations mapping, but... * this implies BKE_libblock_remap & co to be able to update main->relations on the fly. * Have to think about it a bit more, and see whether new code is OK first, anyway. */ diff --git a/source/blender/blenkernel/intern/lib_id_delete.c b/source/blender/blenkernel/intern/lib_id_delete.c index 67b2e4429d6..7ea321b0ee1 100644 --- a/source/blender/blenkernel/intern/lib_id_delete.c +++ b/source/blender/blenkernel/intern/lib_id_delete.c @@ -277,7 +277,7 @@ static size_t id_delete(Main *bmain, const bool do_tagged_deletion) for (id = lb->first; id; id = id_next) { id_next = id->next; - /* Note: in case we delete a library, we also delete all its datablocks! */ + /* NOTE: in case we delete a library, we also delete all its datablocks! */ if ((id->tag & tag) || (id->lib != NULL && (id->lib->id.tag & tag))) { BLI_remlink(lb, id); BLI_addtail(&tagged_deleted_ids, id); @@ -331,7 +331,7 @@ static size_t id_delete(Main *bmain, const bool do_tagged_deletion) for (id = lb->first; id; id = id_next) { id_next = id->next; - /* Note: in case we delete a library, we also delete all its datablocks! */ + /* NOTE: in case we delete a library, we also delete all its datablocks! */ if ((id->tag & tag) || (id->lib != NULL && (id->lib->id.tag & tag))) { id->tag |= tag; diff --git a/source/blender/blenkernel/intern/lib_override.c b/source/blender/blenkernel/intern/lib_override.c index 595e470876d..b5384186c69 100644 --- a/source/blender/blenkernel/intern/lib_override.c +++ b/source/blender/blenkernel/intern/lib_override.c @@ -130,7 +130,7 @@ IDOverrideLibrary *BKE_lib_override_library_init(ID *local_id, ID *reference_id) local_id->override_library->reference = reference_id; id_us_plus(local_id->override_library->reference); local_id->tag &= ~LIB_TAG_OVERRIDE_LIBRARY_REFOK; - /* TODO do we want to add tag or flag to referee to mark it as such? */ + /* TODO: do we want to add tag or flag to referee to mark it as such? */ return local_id->override_library; } @@ -217,7 +217,7 @@ static ID *lib_override_library_create_from(Main *bmain, ID *reference_id, const int lib_id_copy_flags) { - /* Note: We do not want to copy possible override data from reference here (whether it is an + /* NOTE: We do not want to copy possible override data from reference here (whether it is an * override template, or already an override of some other ref data). */ ID *local_id = BKE_id_copy_ex(bmain, reference_id, @@ -232,7 +232,7 @@ static ID *lib_override_library_create_from(Main *bmain, BKE_lib_override_library_init(local_id, reference_id); - /* Note: From liboverride perspective (and RNA one), shape keys are considered as local embedded + /* NOTE: From liboverride perspective (and RNA one), shape keys are considered as local embedded * data-blocks, just like root node trees or master collections. Therefore, we never need to * create overrides for them. We need a way to mark them as overrides though. */ Key *reference_key; @@ -369,7 +369,7 @@ bool BKE_lib_override_library_create_from_tag(Main *bmain, /* If `newid` is already set, assume it has been handled by calling code. * Only current use case: re-using proxy ID when converting to liboverride. */ if (reference_id->newid == NULL) { - /* Note: `no main` case is used during resync procedure, to support recursive resync. + /* NOTE: `no main` case is used during resync procedure, to support recursive resync. * This requires extra care further down the resync process, * see: #BKE_lib_override_library_resync. */ reference_id->newid = lib_override_library_create_from( @@ -569,7 +569,7 @@ static void lib_override_linked_group_tag_recursive(LibOverrideGroupTagData *dat /* We tag all collections and objects for override. And we also tag all other data-blocks which * would use one of those. - * Note: missing IDs (aka placeholders) are never overridden. */ + * NOTE: missing IDs (aka placeholders) are never overridden. */ if (ELEM(GS(to_id->name), ID_OB, ID_GR)) { if ((to_id->tag & LIB_TAG_MISSING)) { to_id->tag |= missing_tag; @@ -1347,7 +1347,7 @@ bool BKE_lib_override_library_resync(Main *bmain, if (do_post_process) { /* Essentially ensures that potentially new overrides of new objects will be instantiated. */ - /* Note: Here 'reference' collection and 'newly added' collection are the same, which is fine + /* NOTE: Here 'reference' collection and 'newly added' collection are the same, which is fine * since we already relinked old root override collection to new resync'ed one above. So this * call is not expected to instantiate this new resync'ed collection anywhere, just to ensure * that we do not have any stray objects. */ @@ -2820,7 +2820,7 @@ void BKE_lib_override_library_update(Main *bmain, ID *local) local->tag |= LIB_TAG_OVERRIDE_LIBRARY_REFOK; - /* Note: Since we reload full content from linked ID here, potentially from edited local + /* NOTE: Since we reload full content from linked ID here, potentially from edited local * override, we do not really have a way to know *what* is changed, so we need to rely on the * massive destruction weapon of `ID_RECALC_ALL` here. */ DEG_id_tag_update_ex(bmain, local, ID_RECALC_ALL); @@ -2907,7 +2907,7 @@ ID *BKE_lib_override_library_operations_store_start(Main *bmain, * other-ID-reference creation/update in that case (since no differential operation is expected * to involve those anyway). */ #if 0 - /* XXX TODO We may also want a specialized handling of things here too, to avoid copying heavy + /* XXX TODO: We may also want a specialized handling of things here too, to avoid copying heavy * never-overridable data (like Mesh geometry etc.)? And also maybe avoid lib * reference-counting completely (shallow copy). */ /* This would imply change in handling of user-count all over RNA diff --git a/source/blender/blenkernel/intern/lib_query.c b/source/blender/blenkernel/intern/lib_query.c index 9d2552777bf..977e53c8474 100644 --- a/source/blender/blenkernel/intern/lib_query.c +++ b/source/blender/blenkernel/intern/lib_query.c @@ -273,7 +273,7 @@ static void library_foreach_ID_link(Main *bmain, continue; } - /* Note: ID.lib pointer is purposefully fully ignored here... + /* NOTE: ID.lib pointer is purposefully fully ignored here... * We may want to add it at some point? */ if (flag & IDWALK_DO_INTERNAL_RUNTIME_POINTERS) { diff --git a/source/blender/blenkernel/intern/lib_remap.c b/source/blender/blenkernel/intern/lib_remap.c index 2641208897e..bba15a3bcdf 100644 --- a/source/blender/blenkernel/intern/lib_remap.c +++ b/source/blender/blenkernel/intern/lib_remap.c @@ -126,7 +126,7 @@ static int foreach_libblock_remap_callback(LibraryIDLinkCallbackData *cb_data) const bool is_reference = (cb_flag & IDWALK_CB_OVERRIDE_LIBRARY_REFERENCE) != 0; const bool is_indirect = (cb_flag & IDWALK_CB_INDIRECT_USAGE) != 0; const bool skip_indirect = (id_remap_data->flag & ID_REMAP_SKIP_INDIRECT_USAGE) != 0; - /* Note: proxy usage implies LIB_TAG_EXTERN, so on this aspect it is direct, + /* NOTE: proxy usage implies LIB_TAG_EXTERN, so on this aspect it is direct, * on the other hand since they get reset to lib data on file open/reload it is indirect too. * Edit Mode is also a 'skip direct' case. */ const bool is_obj = (GS(id_owner->name) == ID_OB); @@ -312,7 +312,7 @@ static void libblock_remap_data_postprocess_collection_update(Main *bmain, /* XXX Complex cases can lead to NULL pointers in other collections than old_collection, * and BKE_main_collection_sync_remap() does not tolerate any of those, so for now always check * whole existing collections for NULL pointers. - * I'd consider optimizing that whole collection remapping process a TODO for later. */ + * I'd consider optimizing that whole collection remapping process a TODO: for later. */ BKE_collections_child_remove_nulls(bmain, owner_collection, NULL /*old_collection*/); } else { @@ -630,7 +630,7 @@ void BKE_libblock_relink_ex( switch (GS(id->name)) { case ID_SCE: case ID_GR: { - /* Note: here we know which collection we have affected, so at lest for NULL children + /* NOTE: here we know which collection we have affected, so at lest for NULL children * detection we can only process that one. * This is also a required fix in case `id` would not be in Main anymore, which can happen * e.g. when called from `id_delete`. */ diff --git a/source/blender/blenkernel/intern/library.c b/source/blender/blenkernel/intern/library.c index 677b9497c98..07a3396ad5f 100644 --- a/source/blender/blenkernel/intern/library.c +++ b/source/blender/blenkernel/intern/library.c @@ -102,10 +102,10 @@ void BKE_library_filepath_set(Main *bmain, Library *lib, const char *filepath) /* Not essential but set `filepath_abs` is an absolute copy of value which * is more useful if its kept in sync. */ if (BLI_path_is_rel(lib->filepath_abs)) { - /* note that the file may be unsaved, in this case, setting the + /* NOTE(campbell): the file may be unsaved, in this case, setting the * `filepath_abs` on an indirectly linked path is not allowed from the * outliner, and its not really supported but allow from here for now - * since making local could cause this to be directly linked - campbell + * since making local could cause this to be directly linked. */ /* Never make paths relative to parent lib - reading code (blenloader) always set *all* * `lib->filepath` relative to current main, not to their parent for indirectly linked ones. */ diff --git a/source/blender/blenkernel/intern/main.c b/source/blender/blenkernel/intern/main.c index 39cc5737ca2..655b6d3732c 100644 --- a/source/blender/blenkernel/intern/main.c +++ b/source/blender/blenkernel/intern/main.c @@ -400,7 +400,7 @@ ImBuf *BKE_main_thumbnail_to_imbuf(Main *bmain, BlendThumbnail *data) } if (data) { - /* Note: we cannot use IMB_allocFromBuffer(), since it tries to dupalloc passed buffer, + /* NOTE: we cannot use IMB_allocFromBuffer(), since it tries to dupalloc passed buffer, * which will fail here (we do not want to pass the first two ints!). */ img = IMB_allocImBuf( (unsigned int)data->width, (unsigned int)data->height, 32, IB_rect | IB_metadata); diff --git a/source/blender/blenkernel/intern/mask.c b/source/blender/blenkernel/intern/mask.c index 371af2a95ed..ee71d60f1e3 100644 --- a/source/blender/blenkernel/intern/mask.c +++ b/source/blender/blenkernel/intern/mask.c @@ -69,7 +69,7 @@ static void mask_copy_data(Main *UNUSED(bmain), BLI_listbase_clear(&mask_dst->masklayers); - /* TODO add unused flag to those as well. */ + /* TODO: add unused flag to those as well. */ BKE_mask_layer_copy_list(&mask_dst->masklayers, &mask_src->masklayers); /* enable fake user by default */ @@ -372,7 +372,7 @@ MaskLayer *BKE_mask_layer_new(Mask *mask, const char *name) return masklay; } -/* note: may still be hidden, caller needs to check */ +/* NOTE: may still be hidden, caller needs to check. */ MaskLayer *BKE_mask_layer_active(Mask *mask) { return BLI_findlink(&mask->masklayers, mask->masklay_act); @@ -1133,7 +1133,7 @@ MaskSpline *BKE_mask_spline_copy(const MaskSpline *spline) return nspline; } -/* note: does NOT add to the list */ +/* NOTE: Does NOT add to the list. */ MaskLayerShape *BKE_mask_layer_shape_alloc(MaskLayer *masklay, const int frame) { MaskLayerShape *masklay_shape; @@ -1422,7 +1422,7 @@ void BKE_mask_get_handle_point_adjacent(MaskSpline *spline, MaskSplinePoint **r_point_prev, MaskSplinePoint **r_point_next) { - /* TODO, could avoid calling this at such low level */ + /* TODO: could avoid calling this at such low level. */ MaskSplinePoint *points_array = BKE_mask_spline_point_array_from_point(spline, point); *r_point_prev = mask_spline_point_prev(spline, points_array, point); @@ -1472,7 +1472,7 @@ void BKE_mask_calc_handle_adjacent_interp(MaskSpline *spline, MaskSplinePoint *point, const float u) { - /* TODO! - make this interpolate between siblings - not always midpoint! */ + /* TODO: make this interpolate between siblings - not always midpoint! */ int length_tot = 0; float length_average = 0.0f; float weight_average = 0.0f; @@ -1942,7 +1942,7 @@ void BKE_mask_layer_shape_changed_add(MaskLayer *masklay, int tot = BKE_mask_layer_shape_totvert(masklay) - 1; /* for interpolation */ - /* TODO - assumes closed curve for now */ + /* TODO: assumes closed curve for now. */ float uv[3][2]; /* 3x 2D handles */ const int pi_curr = spline_point_index; const int pi_prev = ((spline_point_index - 1) + spline->tot_point) % spline->tot_point; diff --git a/source/blender/blenkernel/intern/mask_evaluate.c b/source/blender/blenkernel/intern/mask_evaluate.c index 69f60ca0384..4584d9e527e 100644 --- a/source/blender/blenkernel/intern/mask_evaluate.c +++ b/source/blender/blenkernel/intern/mask_evaluate.c @@ -545,7 +545,7 @@ static float (*mask_spline_feather_differentiated_points_with_resolution__even( float u = (float)j / resol, weight; float co[2], n[2]; - /* TODO - these calls all calculate similar things + /* TODO: these calls all calculate similar things * could be unified for some speed */ BKE_mask_point_segment_co(spline, point_prev, u, co); BKE_mask_point_normal(spline, point_prev, u, n); @@ -691,7 +691,7 @@ static float (*mask_spline_feather_differentiated_points_with_resolution__double float weight_uw, weight_scalar; float co[2]; - /* TODO - these calls all calculate similar things + /* TODO: these calls all calculate similar things * could be unified for some speed */ BKE_mask_point_segment_co(spline, point_prev, u, co); diff --git a/source/blender/blenkernel/intern/mask_rasterize.c b/source/blender/blenkernel/intern/mask_rasterize.c index d29a6e75954..af0047680f2 100644 --- a/source/blender/blenkernel/intern/mask_rasterize.c +++ b/source/blender/blenkernel/intern/mask_rasterize.c @@ -514,7 +514,7 @@ static void layer_bucket_init(MaskRasterLayer *layer, const float pixel_size) BLI_assert(bucket_index < bucket_tot); /* Check if the bucket intersects with the face. */ - /* Note: there is a trade off here since checking box/tri intersections isn't as + /* NOTE: there is a trade off here since checking box/tri intersections isn't as * optimal as it could be, but checking pixels against faces they will never * intersect with is likely the greater slowdown here - * so check if the cell intersects the face. */ @@ -729,7 +729,7 @@ void BKE_maskrasterize_handle_init(MaskRasterHandle *mr_handle, sf_vert_tot++; - /* TODO, an alternate functions so we can avoid double vector copy! */ + /* TODO: an alternate functions so we can avoid double vector copy! */ for (j = 1; j < tot_diff_point; j++) { copy_v2_v2(co, diff_points[j]); sf_vert = BLI_scanfill_vert_add(&sf_ctx, co); @@ -762,7 +762,7 @@ void BKE_maskrasterize_handle_init(MaskRasterHandle *mr_handle, BLI_assert(tot_diff_feather_points == tot_diff_point); - /* Note: only added for convenience, we don't in fact use these to scan-fill, + /* NOTE: only added for convenience, we don't in fact use these to scan-fill, * only to create feather faces after scan-fill. */ for (j = 0; j < tot_diff_feather_points; j++) { copy_v2_v2(co_feather, diff_feather_points[j]); @@ -804,7 +804,7 @@ void BKE_maskrasterize_handle_init(MaskRasterHandle *mr_handle, open_spline_ranges[open_spline_index].vertex_offset = sf_vert_tot; open_spline_ranges[open_spline_index].vertex_total = tot_diff_point; - /* TODO, an alternate functions so we can avoid double vector copy! */ + /* TODO: an alternate functions so we can avoid double vector copy! */ for (j = 0; j < tot_diff_point; j++) { /* center vert */ diff --git a/source/blender/blenkernel/intern/material.c b/source/blender/blenkernel/intern/material.c index c5060e16e4d..4f0b2a718ed 100644 --- a/source/blender/blenkernel/intern/material.c +++ b/source/blender/blenkernel/intern/material.c @@ -135,7 +135,7 @@ static void material_copy_data(Main *bmain, ID *id_dst, const ID *id_src, const BLI_listbase_clear(&material_dst->gpumaterial); - /* TODO Duplicate Engine Settings and set runtime to NULL */ + /* TODO: Duplicate Engine Settings and set runtime to NULL. */ } static void material_free_data(ID *id) @@ -864,7 +864,7 @@ void BKE_object_material_resize(Main *bmain, Object *ob, const short totcol, boo ob->mat = newmatar; ob->matbits = newmatbits; } - /* XXX, why not realloc on shrink? - campbell */ + /* XXX(campbell): why not realloc on shrink? */ ob->totcol = totcol; if (ob->totcol && ob->actcol == 0) { @@ -1168,7 +1168,7 @@ void BKE_object_material_from_eval_data(Main *bmain, Object *ob_orig, ID *data_e BKE_object_materials_test(bmain, ob_orig, data_orig); } -/* XXX - this calls many more update calls per object then are needed, could be optimized */ +/* XXX: this calls many more update calls per object then are needed, could be optimized. */ void BKE_object_material_array_assign(Main *bmain, struct Object *ob, struct Material ***matar, @@ -1823,7 +1823,7 @@ void BKE_material_copybuf_copy(Main *bmain, Material *ma) matcopybuf.preview = NULL; BLI_listbase_clear(&matcopybuf.gpumaterial); - /* TODO Duplicate Engine Settings and set runtime to NULL */ + /* TODO: Duplicate Engine Settings and set runtime to NULL. */ matcopied = 1; } diff --git a/source/blender/blenkernel/intern/mball.c b/source/blender/blenkernel/intern/mball.c index f5d898e801b..6a2b56306d6 100644 --- a/source/blender/blenkernel/intern/mball.c +++ b/source/blender/blenkernel/intern/mball.c @@ -559,7 +559,7 @@ bool BKE_mball_minmax_ex( copy_v3_v3(centroid, &ml->x); } - /* TODO, non circle shapes cubes etc, probably nobody notices - campbell */ + /* TODO(campbell): non circle shapes cubes etc, probably nobody notices. */ for (int i = -1; i != 3; i += 2) { copy_v3_v3(vec, centroid); add_v3_fl(vec, scale_mb * i); diff --git a/source/blender/blenkernel/intern/mball_tessellate.c b/source/blender/blenkernel/intern/mball_tessellate.c index 413cefd2271..760febaca91 100644 --- a/source/blender/blenkernel/intern/mball_tessellate.c +++ b/source/blender/blenkernel/intern/mball_tessellate.c @@ -1336,7 +1336,7 @@ static void init_meta(Depsgraph *depsgraph, PROCESS *process, Scene *scene, Obje } /* untransformed Bounding Box of MetaElem */ - /* TODO, its possible the elem type has been changed and the exp* + /* TODO: its possible the elem type has been changed and the exp* * values can use a fallback. */ copy_v3_fl3(new_ml->bb->vec[0], -expx, -expy, -expz); /* 0 */ copy_v3_fl3(new_ml->bb->vec[1], +expx, -expy, -expz); /* 1 */ @@ -1438,7 +1438,7 @@ void BKE_mball_polygonize(Depsgraph *depsgraph, Scene *scene, Object *ob, ListBa build_bvh_spatial(&process, &process.metaball_bvh, 0, process.totelem, &process.allbb); /* Don't polygonize meta-balls with too high resolution (base mball too small) - * note: Eps was 0.0001f but this was giving problems for blood animation for + * NOTE: Eps was 0.0001f but this was giving problems for blood animation for * the open movie "Sintel", using 0.00001f. */ if (ob->scale[0] > 0.00001f * (process.allbb.max[0] - process.allbb.min[0]) || ob->scale[1] > 0.00001f * (process.allbb.max[1] - process.allbb.min[1]) || diff --git a/source/blender/blenkernel/intern/mesh.c b/source/blender/blenkernel/intern/mesh.c index b518f35fac7..a92401d3ba0 100644 --- a/source/blender/blenkernel/intern/mesh.c +++ b/source/blender/blenkernel/intern/mesh.c @@ -143,7 +143,7 @@ static void mesh_copy_data(Main *bmain, ID *id_dst, const ID *id_src, const int mesh_dst->mselect = MEM_dupallocN(mesh_dst->mselect); - /* TODO Do we want to add flag to prevent this? */ + /* TODO: Do we want to add flag to prevent this? */ if (mesh_src->key && (flag & LIB_ID_COPY_SHAPEKEY)) { BKE_id_copy_ex(bmain, &mesh_src->key->id, (ID **)&mesh_dst->key, flag); /* XXX This is not nice, we need to make BKE_id_copy_ex fully re-entrant... */ @@ -657,12 +657,12 @@ static void mesh_ensure_tessellation_customdata(Mesh *me) CustomData_from_bmeshpoly(&me->fdata, &me->ldata, me->totface); - /* TODO - add some --debug-mesh option */ + /* TODO: add some `--debug-mesh` option. */ if (G.debug & G_DEBUG) { - /* note: this warning may be un-called for if we are initializing the mesh for the - * first time from bmesh, rather than giving a warning about this we could be smarter + /* NOTE(campbell): this warning may be un-called for if we are initializing the mesh for + * the first time from #BMesh, rather than giving a warning about this we could be smarter * and check if there was any data to begin with, for now just print the warning with - * some info to help troubleshoot what's going on - campbell */ + * some info to help troubleshoot what's going on. */ printf( "%s: warning! Tessellation uvs or vcol data got out of sync, " "had to reset!\n CD_MTFACE: %d != CD_MLOOPUV: %d || CD_MCOL: %d != CD_MLOOPCOL: " @@ -2126,7 +2126,7 @@ void BKE_mesh_split_faces(Mesh *mesh, bool free_loop_normals) } } - /* Note: after this point mesh is expected to be valid again. */ + /* NOTE: after this point mesh is expected to be valid again. */ /* CD_NORMAL is expected to be temporary only. */ if (free_loop_normals) { diff --git a/source/blender/blenkernel/intern/mesh_boolean_convert.cc b/source/blender/blenkernel/intern/mesh_boolean_convert.cc index c162458ffb9..9bfb01a257c 100644 --- a/source/blender/blenkernel/intern/mesh_boolean_convert.cc +++ b/source/blender/blenkernel/intern/mesh_boolean_convert.cc @@ -611,7 +611,7 @@ static void copy_or_interp_loop_attributes(Mesh *dest_mesh, source_cd, target_cd, source_layer_i, target_layer_i, orig_loop_index, loop_index, 1); } else { - /* Note: although CustomData_bmesh_interp_n function has bmesh in its name, nothing about + /* NOTE: although CustomData_bmesh_interp_n function has bmesh in its name, nothing about * it is BMesh-specific. We can't use CustomData_interp because it assumes that * all source layers exist in the dest. * A non bmesh version could have the benefit of not copying data into src_blocks_ofs - diff --git a/source/blender/blenkernel/intern/mesh_convert.c b/source/blender/blenkernel/intern/mesh_convert.c index cfad5e1100d..83def999766 100644 --- a/source/blender/blenkernel/intern/mesh_convert.c +++ b/source/blender/blenkernel/intern/mesh_convert.c @@ -1117,7 +1117,7 @@ static void curve_to_mesh_eval_ensure(Object *object) BKE_displist_make_curveTypes_forRender( NULL, NULL, &remapped_object, &remapped_object.runtime.curve_cache->disp, &mesh_eval); - /* Note: this is to be consistent with `BKE_displist_make_curveTypes()`, however that is not a + /* NOTE: this is to be consistent with `BKE_displist_make_curveTypes()`, however that is not a * real issue currently, code here is broken in more than one way, fix(es) will be done * separately. */ if (mesh_eval != NULL) { @@ -1327,7 +1327,7 @@ static int foreach_libblock_make_usercounts_callback(LibraryIDLinkCallbackData * id_us_plus(*id_p); } else if (cb_flag & IDWALK_CB_USER_ONE) { - /* Note: in that context, that one should not be needed (since there should be at least already + /* NOTE: in that context, that one should not be needed (since there should be at least already * one USER_ONE user of that ID), but better be consistent. */ id_us_ensure_real(*id_p); } diff --git a/source/blender/blenkernel/intern/mesh_evaluate.c b/source/blender/blenkernel/intern/mesh_evaluate.c index 6eac96ba85b..7290679bc07 100644 --- a/source/blender/blenkernel/intern/mesh_evaluate.c +++ b/source/blender/blenkernel/intern/mesh_evaluate.c @@ -191,7 +191,7 @@ void BKE_mesh_calc_poly_center(const MPoly *mpoly, } } -/* note, passing polynormal is only a speedup so we can skip calculating it */ +/* NOTE: passing poly-normal is only a speedup so we can skip calculating it. */ float BKE_mesh_calc_poly_area(const MPoly *mpoly, const MLoop *loopstart, const MVert *mvarray) { if (mpoly->totloop == 3) { @@ -656,7 +656,7 @@ void BKE_mesh_calc_volume(const MVert *mverts, } } - /* Note: Depending on arbitrary centroid position, + /* NOTE: Depending on arbitrary centroid position, * totvol can become negative even for a valid mesh. * The true value is always the positive value. */ @@ -664,7 +664,7 @@ void BKE_mesh_calc_volume(const MVert *mverts, *r_volume = fabsf(totvol); } if (r_center) { - /* Note: Factor 1/3 is applied once for all vertices here. + /* NOTE: Factor 1/3 is applied once for all vertices here. * This also automatically negates the vector if totvol is negative. */ if (totvol != 0.0f) { @@ -943,7 +943,7 @@ void BKE_mesh_convert_mfaces_to_mpolys_ex(ID *id, } } - /* note, we don't convert NGons at all, these are not even real ngons, + /* NOTE: we don't convert NGons at all, these are not even real ngons, * they have their own UV's, colors etc - its more an editing feature. */ BLI_edgehash_free(eh, NULL); diff --git a/source/blender/blenkernel/intern/mesh_mapping.c b/source/blender/blenkernel/intern/mesh_mapping.c index c469a65449d..9a3333fce6c 100644 --- a/source/blender/blenkernel/intern/mesh_mapping.c +++ b/source/blender/blenkernel/intern/mesh_mapping.c @@ -776,7 +776,7 @@ static void poly_edge_loop_islands_calc(const MEdge *medge, } if (UNLIKELY(gid_bit > 31)) { /* All bits used in contiguous smooth groups, we can't do much! - * Note: this is *very* unlikely - theoretically, four groups are enough, + * NOTE: this is *very* unlikely - theoretically, four groups are enough, * I don't think we can reach this goal with such a simple algorithm, * but I don't think either we'll never need all 32 groups! */ @@ -1140,7 +1140,7 @@ static bool mesh_calc_islands_loop_poly_uv(MVert *UNUSED(verts), poly_indices = MEM_mallocN(sizeof(*poly_indices) * (size_t)totpoly, __func__); loop_indices = MEM_mallocN(sizeof(*loop_indices) * (size_t)totloop, __func__); - /* Note: here we ignore '0' invalid group - this should *never* happen in this case anyway? */ + /* NOTE: here we ignore '0' invalid group - this should *never* happen in this case anyway? */ for (grp_idx = 1; grp_idx <= num_poly_groups; grp_idx++) { num_pidx = num_lidx = 0; if (num_edge_borders) { diff --git a/source/blender/blenkernel/intern/mesh_merge.c b/source/blender/blenkernel/intern/mesh_merge.c index 1e51ee73c7c..d3d835378ca 100644 --- a/source/blender/blenkernel/intern/mesh_merge.c +++ b/source/blender/blenkernel/intern/mesh_merge.c @@ -259,7 +259,7 @@ Mesh *BKE_mesh_merge_verts(Mesh *mesh, STACK_DECLARE(mvert); STACK_DECLARE(oldv); - /* Note: create (totedge + totloop) elements because partially invalid polys due to merge may + /* NOTE: create (totedge + totloop) elements because partially invalid polys due to merge may * require generating new edges, and while in 99% cases we'll still end with less final edges * than totedge, cases can be forged that would end requiring more. */ MEdge *med, *medge = MEM_malloc_arrayN((totedge + totloop), sizeof(*medge), __func__); diff --git a/source/blender/blenkernel/intern/mesh_normals.c b/source/blender/blenkernel/intern/mesh_normals.c index a268f814cd0..89fd7f92d94 100644 --- a/source/blender/blenkernel/intern/mesh_normals.c +++ b/source/blender/blenkernel/intern/mesh_normals.c @@ -597,7 +597,7 @@ void BKE_lnor_space_define(MLoopNorSpace *lnor_space, BLI_stack_discard(edge_vectors); nbr++; } - /* Note: In theory, this could be 'nbr > 2', + /* NOTE: In theory, this could be 'nbr > 2', * but there is one case where we only have two edges for two loops: * a smooth vertex with only two edges and two faces (our Monkey's nose has that, e.g.). */ @@ -827,7 +827,7 @@ static void mesh_edges_sharp_tag(LoopSplitTaskDataCommon *data, const int numEdges = data->numEdges; const int numPolys = data->numPolys; - float(*loopnors)[3] = data->loopnors; /* Note: loopnors may be NULL here. */ + float(*loopnors)[3] = data->loopnors; /* NOTE: loopnors may be NULL here. */ const float(*polynors)[3] = data->polynors; int(*edge_to_loops)[2] = data->edge_to_loops; @@ -879,7 +879,7 @@ static void mesh_edges_sharp_tag(LoopSplitTaskDataCommon *data, */ if (!(mp->flag & ME_SMOOTH) || (medges[ml_curr->e].flag & ME_SHARP) || ml_curr->v == mloops[e2l[0]].v || is_angle_sharp) { - /* Note: we are sure that loop != 0 here ;) */ + /* NOTE: we are sure that loop != 0 here ;). */ e2l[1] = INDEX_INVALID; /* We want to avoid tagging edges as sharp when it is already defined as such by @@ -1481,7 +1481,7 @@ static void loop_split_generator(TaskPool *pool, LoopSplitTaskDataCommon *common * If we find a new, never-processed cyclic smooth fan, we can do it now using that loop/edge * as 'entry point', otherwise we can skip it. */ - /* Note: In theory, we could make #loop_split_generator_check_cyclic_smooth_fan() store + /* NOTE: In theory, we could make #loop_split_generator_check_cyclic_smooth_fan() store * mlfan_vert_index'es and edge indexes in two stacks, to avoid having to fan again around * the vert during actual computation of `clnor` & `clnorspace`. * However, this would complicate the code, add more memory usage, and despite its logical diff --git a/source/blender/blenkernel/intern/mesh_remap.c b/source/blender/blenkernel/intern/mesh_remap.c index b7cff624a04..6691b274e25 100644 --- a/source/blender/blenkernel/intern/mesh_remap.c +++ b/source/blender/blenkernel/intern/mesh_remap.c @@ -216,7 +216,7 @@ static void mesh_calc_eigen_matrix(const MVert *verts, } unit_m4(r_mat); - /* Note: here we apply sample correction to covariance matrix, since we consider the vertices + /* NOTE: here we apply sample correction to covariance matrix, since we consider the vertices * as a sample of the whole 'surface' population of our mesh. */ BLI_covariance_m3_v3n(vcos, numverts, true, covmat, center); @@ -256,7 +256,7 @@ static void mesh_calc_eigen_matrix(const MVert *verts, float evi = eigen_val[i]; /* Protect against 1D/2D degenerated cases! */ - /* Note: not sure why we need square root of eigen values here + /* NOTE: not sure why we need square root of eigen values here * (which are equivalent to singular values, as far as I have understood), * but it seems to heavily reduce (if not completely nullify) * the error due to non-uniform scalings... */ @@ -1035,7 +1035,7 @@ void BKE_mesh_remap_calc_edges_from_mesh(const int mode, if (!weights[j]) { continue; } - /* Note: sources_num is always <= j! */ + /* NOTE: sources_num is always <= j! */ weights[sources_num] = weights[j] / totweights; indices[sources_num] = j; sources_num++; @@ -2332,7 +2332,7 @@ void BKE_mesh_remap_calc_polys_from_mesh(const int mode, for (i = 0; i < numpolys_dst; i++) { /* For each dst poly, we sample some rays from it (2D grid in pnor space) * and use their hits to interpolate from source polys. */ - /* Note: dst poly is early-converted into src space! */ + /* NOTE: dst poly is early-converted into src space! */ MPoly *mp = &polys_dst[i]; int tot_rays, done_rays = 0; @@ -2465,7 +2465,7 @@ void BKE_mesh_remap_calc_polys_from_mesh(const int mode, if (!weights[j]) { continue; } - /* Note: sources_num is always <= j! */ + /* NOTE: sources_num is always <= j! */ weights[sources_num] = weights[j] / totweights; indices[sources_num] = j; sources_num++; diff --git a/source/blender/blenkernel/intern/mesh_runtime.c b/source/blender/blenkernel/intern/mesh_runtime.c index 47d300dc0c2..7ac4c29f0ee 100644 --- a/source/blender/blenkernel/intern/mesh_runtime.c +++ b/source/blender/blenkernel/intern/mesh_runtime.c @@ -290,7 +290,7 @@ static void mesh_runtime_debug_info_layers(DynStr *dynstr, CustomData *cd) for (type = 0; type < CD_NUMTYPES; type++) { if (CustomData_has_layer(cd, type)) { - /* note: doesn't account for multiple layers */ + /* NOTE: doesn't account for multiple layers. */ const char *name = CustomData_layertype_name(type); const int size = CustomData_sizeof(type); const void *pt = CustomData_get_layer(cd, type); diff --git a/source/blender/blenkernel/intern/mesh_tangent.c b/source/blender/blenkernel/intern/mesh_tangent.c index 2e22e521a13..e5e971fd574 100644 --- a/source/blender/blenkernel/intern/mesh_tangent.c +++ b/source/blender/blenkernel/intern/mesh_tangent.c @@ -119,7 +119,7 @@ static void set_tspace(const SMikkTSpaceContext *pContext, * Compute simplified tangent space normals, i.e. * tangent vector + sign of bi-tangent one, which combined with * split normals can be used to recreate the full tangent space. - * Note: * The mesh should be made of only tris and quads! + * NOTE: * The mesh should be made of only tris and quads! */ void BKE_mesh_calc_loop_tangent_single_ex(const MVert *mverts, const int UNUSED(numVerts), @@ -675,7 +675,7 @@ void BKE_mesh_calc_loop_tangent_ex(const MVert *mvert, mesh2tangent->mpoly = mpoly; mesh2tangent->mloop = mloop; mesh2tangent->looptri = looptri; - /* Note, we assume we do have tessellated loop normals at this point + /* NOTE: we assume we do have tessellated loop normals at this point * (in case it is object-enabled), have to check this is valid. */ mesh2tangent->precomputedLoopNormals = loop_normals; mesh2tangent->precomputedFaceNormals = poly_normals; diff --git a/source/blender/blenkernel/intern/mesh_validate.c b/source/blender/blenkernel/intern/mesh_validate.c index bfdbf844a26..08668d55cf4 100644 --- a/source/blender/blenkernel/intern/mesh_validate.c +++ b/source/blender/blenkernel/intern/mesh_validate.c @@ -154,7 +154,7 @@ static int search_face_cmp(const void *v1, const void *v2) return 0; } -/* TODO check there is not some standard define of this somewhere! */ +/* TODO: check there is not some standard define of this somewhere! */ static int int_cmp(const void *v1, const void *v2) { return *(int *)v1 > *(int *)v2 ? 1 : *(int *)v1 < *(int *)v2 ? -1 : 0; @@ -819,7 +819,7 @@ bool BKE_mesh_validate_arrays(Mesh *mesh, MDeformWeight *dw; for (j = 0, dw = dv->dw; j < dv->totweight; j++, dw++) { - /* note, greater than max defgroups is accounted for in our code, but not < 0 */ + /* NOTE: greater than max defgroups is accounted for in our code, but not < 0. */ if (!isfinite(dw->weight)) { PRINT_ERR("\tVertex deform %u, group %u has weight: %f", i, dw->def_nr, dw->weight); if (do_fixes) { @@ -1287,7 +1287,7 @@ void BKE_mesh_strip_loose_polysloops(Mesh *me) } /* And now, update polys' start loop index. */ - /* Note: At this point, there should never be any poly using a striped loop! */ + /* NOTE: At this point, there should never be any poly using a striped loop! */ for (a = 0, p = me->mpoly; a < me->totpoly; a++, p++) { p->loopstart = new_idx[p->loopstart]; } diff --git a/source/blender/blenkernel/intern/modifier.c b/source/blender/blenkernel/intern/modifier.c index e60f0102b9a..2088c4268e6 100644 --- a/source/blender/blenkernel/intern/modifier.c +++ b/source/blender/blenkernel/intern/modifier.c @@ -156,7 +156,7 @@ ModifierData *BKE_modifier_new(int type) const ModifierTypeInfo *mti = BKE_modifier_get_info(type); ModifierData *md = MEM_callocN(mti->structSize, mti->structName); - /* note, this name must be made unique later */ + /* NOTE: this name must be made unique later. */ BLI_strncpy(md->name, DATA_(mti->name), sizeof(md->name)); md->type = type; diff --git a/source/blender/blenkernel/intern/movieclip.c b/source/blender/blenkernel/intern/movieclip.c index 3a7910d1a9f..f32b0c434c1 100644 --- a/source/blender/blenkernel/intern/movieclip.c +++ b/source/blender/blenkernel/intern/movieclip.c @@ -287,7 +287,7 @@ static void movieclip_blend_read_data(BlendDataReader *reader, ID *id) clip->tracking_context = NULL; clip->tracking.stats = NULL; - /* TODO we could store those in undo cache storage as well, and preserve them instead of + /* TODO: we could store those in undo cache storage as well, and preserve them instead of * re-creating them... */ BLI_listbase_clear(&clip->runtime.gputextures); @@ -1849,7 +1849,7 @@ static void movieclip_build_proxy_ibuf( IMB_freeImBuf(scaleibuf); } -/* note: currently used by proxy job for movies, threading happens within single frame +/* NOTE: currently used by proxy job for movies, threading happens within single frame * (meaning scaling shall be threaded) */ void BKE_movieclip_build_proxy_frame(MovieClip *clip, @@ -1893,7 +1893,7 @@ void BKE_movieclip_build_proxy_frame(MovieClip *clip, } } -/* note: currently used by proxy job for sequences, threading happens within sequence +/* NOTE: currently used by proxy job for sequences, threading happens within sequence * (different threads handles different frames, no threading within frame is needed) */ void BKE_movieclip_build_proxy_frame_for_ibuf(MovieClip *clip, diff --git a/source/blender/blenkernel/intern/node.cc b/source/blender/blenkernel/intern/node.cc index e6635665567..56d8853f0cb 100644 --- a/source/blender/blenkernel/intern/node.cc +++ b/source/blender/blenkernel/intern/node.cc @@ -364,7 +364,7 @@ static void node_foreach_cache(ID *id, key.offset_in_ID = offsetof(bNodeTree, previews); key.cache_v = nodetree->previews; - /* TODO, see also `direct_link_nodetree()` in readfile.c. */ + /* TODO: see also `direct_link_nodetree()` in readfile.c. */ #if 0 function_callback(id, &key, (void **)&nodetree->previews, 0, user_data); #endif @@ -645,7 +645,7 @@ static void direct_link_node_socket(BlendDataReader *reader, bNodeSocket *sock) /* ntree itself has been read! */ void ntreeBlendReadData(BlendDataReader *reader, bNodeTree *ntree) { - /* note: writing and reading goes in sync, for speed */ + /* NOTE: writing and reading goes in sync, for speed. */ ntree->init = 0; /* to set callbacks and force setting types */ ntree->is_updating = false; ntree->typeinfo = nullptr; @@ -796,7 +796,7 @@ void ntreeBlendReadData(BlendDataReader *reader, bNodeTree *ntree) BLO_read_data_address(reader, &link->tosock); } - /* TODO, should be dealt by new generic cache handling of IDs... */ + /* TODO: should be dealt by new generic cache handling of IDs... */ ntree->previews = nullptr; /* type verification is in lib-link */ @@ -1042,7 +1042,7 @@ static void node_add_sockets_from_type(bNodeTree *ntree, bNode *node, bNodeType } } -/* Note: This function is called to initialize node data based on the type. +/* NOTE: This function is called to initialize node data based on the type. * The bNodeType may not be registered at creation time of the node, * so this can be delayed until the node type gets registered. */ @@ -1064,7 +1064,7 @@ static void node_init(const struct bContext *C, bNodeTree *ntree, bNode *node) node->height = ntype->height; node->color[0] = node->color[1] = node->color[2] = 0.608; /* default theme color */ /* initialize the node name with the node label. - * note: do this after the initfunc so nodes get their data set which may be used in naming + * NOTE: do this after the initfunc so nodes get their data set which may be used in naming * (node groups for example) */ /* XXX Do not use nodeLabel() here, it returns translated content for UI, * which should *only* be used in UI, *never* in data... @@ -2883,7 +2883,7 @@ void BKE_node_preview_merge_tree(bNodeTree *to_ntree, bNodeTree *from_ntree, boo BKE_node_instance_hash_insert(to_ntree->previews, key, preview); } - /* Note: null free function here, + /* NOTE: null free function here, * because pointers have already been moved over to to_ntree->previews! */ BKE_node_instance_hash_free(from_ntree->previews, nullptr); from_ntree->previews = nullptr; @@ -3274,7 +3274,7 @@ bNodeTree *ntreeLocalize(bNodeTree *ntree) { if (ntree) { /* Make full copy outside of Main database. - * Note: previews are not copied here. + * NOTE: previews are not copied here. */ bNodeTree *ltree = (bNodeTree *)BKE_id_copy_ex( nullptr, &ntree->id, nullptr, (LIB_ID_COPY_LOCALIZE | LIB_ID_COPY_NO_ANIMDATA)); @@ -4751,7 +4751,7 @@ static bool node_undefined_poll(bNodeType *UNUSED(ntype), /* register fallback types used for undefined tree, nodes, sockets */ static void register_undefined_types() { - /* Note: these types are not registered in the type hashes, + /* NOTE: these types are not registered in the type hashes, * they are just used as placeholders in case the actual types are not registered. */ diff --git a/source/blender/blenkernel/intern/object.c b/source/blender/blenkernel/intern/object.c index ff5d94d20b7..5b8b701c975 100644 --- a/source/blender/blenkernel/intern/object.c +++ b/source/blender/blenkernel/intern/object.c @@ -251,7 +251,7 @@ static void object_copy_data(Main *bmain, ID *id_dst, const ID *id_src, const in BLI_listbase_clear(&ob_dst->modifiers); BLI_listbase_clear(&ob_dst->greasepencil_modifiers); - /* Note: Also takes care of softbody and particle systems copying. */ + /* NOTE: Also takes care of softbody and particle systems copying. */ BKE_object_modifier_stack_copy(ob_dst, ob_src, true, flag_subdata); BLI_listbase_clear((ListBase *)&ob_dst->drawdata); @@ -262,7 +262,7 @@ static void object_copy_data(Main *bmain, ID *id_dst, const ID *id_src, const in /* Do not copy object's preview * (mostly due to the fact renderers create temp copy of objects). */ - if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0 && false) { /* XXX TODO temp hack */ + if ((flag & LIB_ID_COPY_NO_PREVIEW) == 0 && false) { /* XXX TODO: temp hack. */ BKE_previewimg_id_copy(&ob_dst->id, &ob_src->id); } else { @@ -2380,8 +2380,8 @@ ParticleSystem *BKE_object_copy_particlesystem(ParticleSystem *psys, const int f psysn->pointcache = BKE_ptcache_copy_list(&psysn->ptcaches, &psys->ptcaches, flag); } - /* XXX - from reading existing code this seems correct but intended usage of - * pointcache should /w cloth should be added in 'ParticleSystem' - campbell */ + /* XXX(campbell): from reading existing code this seems correct but intended usage of + * pointcache should /w cloth should be added in 'ParticleSystem'. */ if (psysn->clmd) { psysn->clmd->point_cache = psysn->pointcache; } @@ -2439,7 +2439,7 @@ void BKE_object_copy_particlesystems(Object *ob_dst, const Object *ob_src, const static void copy_object_pose(Object *obn, const Object *ob, const int flag) { - /* note: need to clear obn->pose pointer first, + /* NOTE: need to clear obn->pose pointer first, * so that BKE_pose_copy_data works (otherwise there's a crash) */ obn->pose = NULL; BKE_pose_copy_data_ex(&obn->pose, ob->pose, flag, true); /* true = copy constraints */ @@ -4089,7 +4089,7 @@ bool BKE_object_empty_image_data_is_visible_in_view3d(const Object *ob, const Re if ((visibility_flag & (OB_EMPTY_IMAGE_HIDE_BACK | OB_EMPTY_IMAGE_HIDE_FRONT)) != 0) { float eps, dot; if (rv3d->is_persp) { - /* Note, we could normalize the 'view_dir' then use 'eps' + /* NOTE: we could normalize the 'view_dir' then use 'eps' * however the issue with empty objects being visible when viewed from the side * is only noticeable in orthographic views. */ float view_dir[3]; @@ -5616,7 +5616,7 @@ bool BKE_object_modifier_update_subframe(Depsgraph *depsgraph, } } - /* was originally ID_RECALC_ALL - TODO - which flags are really needed??? */ + /* was originally ID_RECALC_ALL - TODO: which flags are really needed??? */ /* TODO(sergey): What about animation? */ const AnimationEvalContext anim_eval_context = BKE_animsys_eval_context_construct(depsgraph, frame); diff --git a/source/blender/blenkernel/intern/ocean.c b/source/blender/blenkernel/intern/ocean.c index 2e7152302c7..3aee5cd639d 100644 --- a/source/blender/blenkernel/intern/ocean.c +++ b/source/blender/blenkernel/intern/ocean.c @@ -62,7 +62,7 @@ static float nextfr(RNG *rng, float min, float max) static float gaussRand(RNG *rng) { - /* Note: to avoid numerical problems with very small numbers, we make these variables + /* NOTE: to avoid numerical problems with very small numbers, we make these variables * singe-precision floats, but later we call the double-precision log() and sqrt() functions * instead of logf() and sqrtf(). */ float x; @@ -1381,9 +1381,9 @@ void BKE_ocean_bake(struct Ocean *o, void (*update_cb)(void *, float progress, int *cancel), void *update_cb_data) { - /* note: some of these values remain uninitialized unless certain options + /* NOTE(campbell): some of these values remain uninitialized unless certain options * are enabled, take care that BKE_ocean_eval_ij() initializes a member - * before use - campbell */ + * before use. */ OceanResult ocr; ImageFormatData imf = {0}; @@ -1437,7 +1437,7 @@ void BKE_ocean_bake(struct Ocean *o, rgb_to_rgba_unit_alpha(&ibuf_disp->rect_float[4 * (res_x * y + x)], ocr.disp); if (o->_do_jacobian) { - /* TODO: cleanup unused code - campbell */ + /* TODO(campbell): cleanup unused code. */ float /* r, */ /* UNUSED */ pr = 0.0f, foam_result; float neg_disp, neg_eplus; diff --git a/source/blender/blenkernel/intern/packedFile.c b/source/blender/blenkernel/intern/packedFile.c index 87239d160b4..78e7e11c248 100644 --- a/source/blender/blenkernel/intern/packedFile.c +++ b/source/blender/blenkernel/intern/packedFile.c @@ -527,7 +527,7 @@ static void unpack_generate_paths(const char *name, BLI_split_dirfile(name, tempdir, tempname, sizeof(tempdir), sizeof(tempname)); if (tempname[0] == '\0') { - /* Note: we generally do not have any real way to re-create extension out of data. */ + /* NOTE: we generally do not have any real way to re-create extension out of data. */ BLI_strncpy(tempname, id->name + 2, sizeof(tempname)); printf("%s\n", tempname); diff --git a/source/blender/blenkernel/intern/paint.c b/source/blender/blenkernel/intern/paint.c index a7c6dc2deb9..1af66fa090b 100644 --- a/source/blender/blenkernel/intern/paint.c +++ b/source/blender/blenkernel/intern/paint.c @@ -128,8 +128,8 @@ static void palette_blend_read_data(BlendDataReader *reader, ID *id) static void palette_undo_preserve(BlendLibReader *UNUSED(reader), ID *id_new, ID *id_old) { /* Whole Palette is preserved across undo-steps, and it has no extra pointer, simple. */ - /* Note: We do not care about potential internal references to self here, Palette has none. */ - /* Note: We do not swap IDProperties, as dealing with potential ID pointers in those would be + /* NOTE: We do not care about potential internal references to self here, Palette has none. */ + /* NOTE: We do not swap IDProperties, as dealing with potential ID pointers in those would be * fairly delicate. */ BKE_lib_id_swap(NULL, id_new, id_old); SWAP(IDProperty *, id_new->properties, id_old->properties); @@ -2067,7 +2067,7 @@ void BKE_sculpt_ensure_orig_mesh_data(Scene *scene, Object *object) /* If a sculpt session is active, ensure we have its faceset data porperly up-to-date. */ object->sculpt->face_sets = CustomData_get_layer(&mesh->pdata, CD_SCULPT_FACE_SETS); - /* Note: In theory we could add that on the fly when required by sculpt code. + /* NOTE: In theory we could add that on the fly when required by sculpt code. * But this then requires proper update of depsgraph etc. For now we play safe, optimization is * always possible later if it's worth it. */ BKE_sculpt_mask_layers_ensure(object, mmd); diff --git a/source/blender/blenkernel/intern/particle.c b/source/blender/blenkernel/intern/particle.c index d386967bf8b..7504fbeed19 100644 --- a/source/blender/blenkernel/intern/particle.c +++ b/source/blender/blenkernel/intern/particle.c @@ -2811,7 +2811,7 @@ static void psys_task_init_path(ParticleTask *task, ParticleSimulationData *sim) task->rng_path = BLI_rng_new(seed); } -/* note: this function must be thread safe, except for branching! */ +/* NOTE: this function must be thread safe, except for branching! */ static void psys_thread_create_path(ParticleTask *task, struct ChildParticle *cpa, ParticleCacheKey *child_keys, @@ -5400,8 +5400,8 @@ void BKE_particle_system_blend_read_lib(BlendLibReader *reader, BLO_read_id_address(reader, id->lib, &psys->target_ob); if (psys->clmd) { - /* XXX - from reading existing code this seems correct but intended usage of - * pointcache /w cloth should be added in 'ParticleSystem' - campbell */ + /* XXX(campbell): from reading existing code this seems correct but intended usage of + * pointcache /w cloth should be added in 'ParticleSystem'. */ psys->clmd->point_cache = psys->pointcache; psys->clmd->ptcaches.first = psys->clmd->ptcaches.last = NULL; BLO_read_id_address(reader, id->lib, &psys->clmd->coll_parms->group); diff --git a/source/blender/blenkernel/intern/particle_child.c b/source/blender/blenkernel/intern/particle_child.c index 2231731287d..415147fb36a 100644 --- a/source/blender/blenkernel/intern/particle_child.c +++ b/source/blender/blenkernel/intern/particle_child.c @@ -331,7 +331,7 @@ void psys_apply_child_modifiers(ParticleThreadContext *ctx, int totkeys, k; float max_length; - /* TODO for the future: use true particle modifiers that work on the whole curve */ + /* TODO: for the future: use true particle modifiers that work on the whole curve. */ (void)modifiers; (void)mod; diff --git a/source/blender/blenkernel/intern/particle_distribute.c b/source/blender/blenkernel/intern/particle_distribute.c index 1fd99bb2cbd..863476c6638 100644 --- a/source/blender/blenkernel/intern/particle_distribute.c +++ b/source/blender/blenkernel/intern/particle_distribute.c @@ -472,7 +472,7 @@ static int distribute_binary_search(const float *sum, int n, float value) * be sure to keep up to date if this changes */ #define PSYS_RND_DIST_SKIP 3 -/* note: this function must be thread safe, for from == PART_FROM_CHILD */ +/* NOTE: this function must be thread safe, for `from == PART_FROM_CHILD`. */ #define ONLY_WORKING_WITH_PA_VERTS 0 static void distribute_from_verts_exec(ParticleTask *thread, ParticleData *pa, int p) { @@ -1214,7 +1214,7 @@ static int psys_thread_context_init_distribute(ParticleThreadContext *ctx, * It allows us to consider pos as 'midpoint between v and v+1' * (or 'p and p+1', depending whether we have more vertices than particles or not), * and avoid stumbling over float impression in element_sum. - * Note: moved face and volume distribution to this as well (instead of starting at zero), + * NOTE: moved face and volume distribution to this as well (instead of starting at zero), * for the same reasons, see T52682. */ pos = (totpart < totmapped) ? 0.5 / (double)totmapped : step * 0.5; /* We choose the smaller step. */ diff --git a/source/blender/blenkernel/intern/particle_system.c b/source/blender/blenkernel/intern/particle_system.c index c35f703b072..06d3daaf4d6 100644 --- a/source/blender/blenkernel/intern/particle_system.c +++ b/source/blender/blenkernel/intern/particle_system.c @@ -447,9 +447,9 @@ void psys_calc_dmcache(Object *ob, Mesh *mesh_final, Mesh *mesh_original, Partic MEM_freeN(nodedmelem); } else { - /* TODO PARTICLE, make the following line unnecessary, each function + /* TODO_PARTICLE: make the following line unnecessary, each function * should know to use the num or num_dmcache, set the num_dmcache to - * an invalid value, just in case */ + * an invalid value, just in case. */ LOOP_PARTICLES { @@ -992,9 +992,9 @@ void psys_get_birth_coords( /* (part->rotmode == PART_ROT_NOR_TAN) */ float tmat[3][3]; - /* note: utan_local is not taken from 'utan', we calculate from rot_vec/vtan */ - /* note: it looks like rotation phase may be applied twice (once with vtan, again below) - * however this isn't the case - campbell */ + /* NOTE: utan_local is not taken from 'utan', we calculate from rot_vec/vtan. */ + /* NOTE(campbell): it looks like rotation phase may be applied twice + * (once with vtan, again below) however this isn't the case. */ float *rot_vec_local = tmat[0]; float *vtan_local = tmat[1]; float *utan_local = tmat[2]; @@ -1014,7 +1014,7 @@ void psys_get_birth_coords( cross_v3_v3v3(utan_local, vtan_local, rot_vec_local); cross_v3_v3v3(vtan_local, utan_local, rot_vec_local); - /* note: no need to normalize */ + /* NOTE: no need to normalize. */ mat3_to_quat(q2, tmat); } @@ -2617,7 +2617,7 @@ static float collision_newton_rhapson(ParticleCollision *col, * here. */ if (d1 == d0) { /* If first iteration, try from other end where the gradient may be - * greater. Note: code duplicated below. */ + * greater. NOTE: code duplicated below. */ if (iter == 0) { t0 = 1.0f; collision_interpolate_element(pce, t0, col->f, col); @@ -2638,7 +2638,7 @@ static float collision_newton_rhapson(ParticleCollision *col, t1 -= d1 * dd; /* Particle moving away from plane could also mean a strangely rotating - * face, so check from end. Note: code duplicated above. */ + * face, so check from end. NOTE: code duplicated above. */ if (iter == 0 && t1 < 0.0f) { t0 = 1.0f; collision_interpolate_element(pce, t0, col->f, col); diff --git a/source/blender/blenkernel/intern/pbvh.c b/source/blender/blenkernel/intern/pbvh.c index 0d84022da77..18b4c72932d 100644 --- a/source/blender/blenkernel/intern/pbvh.c +++ b/source/blender/blenkernel/intern/pbvh.c @@ -1053,7 +1053,7 @@ static void pbvh_update_normals_accum_task_cb(void *__restrict userdata, const int v = vtri[j]; if (pbvh->verts[v].flag & ME_VERT_PBVH_UPDATE) { - /* Note: This avoids `lock, add_v3_v3, unlock` + /* NOTE: This avoids `lock, add_v3_v3, unlock` * and is five to ten times quicker than a spin-lock. * Not exact equivalent though, since atomicity is only ensured for one component * of the vector at a time, but here it shall not make any sensible difference. */ diff --git a/source/blender/blenkernel/intern/pbvh_bmesh.c b/source/blender/blenkernel/intern/pbvh_bmesh.c index c2483b265a5..d3d7f02ecad 100644 --- a/source/blender/blenkernel/intern/pbvh_bmesh.c +++ b/source/blender/blenkernel/intern/pbvh_bmesh.c @@ -1324,7 +1324,7 @@ static void pbvh_bmesh_collapse_edge(PBVH *pbvh, /* For all remaining faces of v_del, create a new face that is the * same except it uses v_conn instead of v_del */ - /* Note: this could be done with BM_vert_splice(), but that + /* NOTE: this could be done with BM_vert_splice(), but that * requires handling other issues like duplicate edges, so doesn't * really buy anything. */ BLI_buffer_clear(deleted_faces); diff --git a/source/blender/blenkernel/intern/pbvh_intern.h b/source/blender/blenkernel/intern/pbvh_intern.h index 948b57578dc..84c4ae4dead 100644 --- a/source/blender/blenkernel/intern/pbvh_intern.h +++ b/source/blender/blenkernel/intern/pbvh_intern.h @@ -30,7 +30,7 @@ typedef struct { float bmin[3], bmax[3], bcentroid[3]; } BBC; -/* Note: this structure is getting large, might want to split it into +/* NOTE: this structure is getting large, might want to split it into * union'd structs */ struct PBVHNode { /* Opaque handle for drawing code */ diff --git a/source/blender/blenkernel/intern/pointcache.c b/source/blender/blenkernel/intern/pointcache.c index a05eb6962ce..90018e64f78 100644 --- a/source/blender/blenkernel/intern/pointcache.c +++ b/source/blender/blenkernel/intern/pointcache.c @@ -849,7 +849,7 @@ static void ptcache_rigidbody_interpolate(int index, dfra = cfra2 - cfra1; - /* note: keys[0] and keys[3] unused for type < 1 (crappy) */ + /* NOTE: keys[0] and keys[3] unused for type < 1 (crappy). */ psys_interpolate_particle(-1, keys, (cfra - cfra1) / dfra, &result, true); interp_qt_qtqt(result.rot, keys[1].rot, keys[2].rot, (cfra - cfra1) / dfra); @@ -1837,7 +1837,7 @@ static void ptcache_data_copy(void *from[], void *to[]) { int i; for (i = 0; i < BPHYS_TOT_DATA; i++) { - /* note, durian file 03.4b_comp crashes if to[i] is not tested + /* NOTE: durian file 03.4b_comp crashes if to[i] is not tested * its NULL, not sure if this should be fixed elsewhere but for now its needed */ if (from[i] && to[i]) { memcpy(to[i], from[i], ptcache_data_size[i]); diff --git a/source/blender/blenkernel/intern/rigidbody.c b/source/blender/blenkernel/intern/rigidbody.c index 2d4cce4b953..9c6610f88fd 100644 --- a/source/blender/blenkernel/intern/rigidbody.c +++ b/source/blender/blenkernel/intern/rigidbody.c @@ -1787,7 +1787,7 @@ static void rigidbody_update_simulation(Depsgraph *depsgraph, rigidbody_update_sim_world(scene, rbw); - /* XXX TODO For rebuild: remove all constraints first. + /* XXX TODO: For rebuild: remove all constraints first. * Otherwise we can end up deleting objects that are still * referenced by constraints, corrupting bullet's internal list. * @@ -1811,7 +1811,7 @@ static void rigidbody_update_simulation(Depsgraph *depsgraph, /* validate that we've got valid object set up here... */ RigidBodyOb *rbo = ob->rigidbody_object; - /* TODO remove this whole block once we are sure we never get NULL rbo here anymore. */ + /* TODO: remove this whole block once we are sure we never get NULL rbo here anymore. */ /* This cannot be done in CoW evaluation context anymore... */ if (rbo == NULL) { BLI_assert(!"CoW object part of RBW object collection without RB object data, " @@ -1868,7 +1868,7 @@ static void rigidbody_update_simulation(Depsgraph *depsgraph, /* validate that we've got valid object set up here... */ RigidBodyCon *rbc = ob->rigidbody_constraint; - /* TODO remove this whole block once we are sure we never get NULL rbo here anymore. */ + /* TODO: remove this whole block once we are sure we never get NULL rbo here anymore. */ /* This cannot be done in CoW evaluation context anymore... */ if (rbc == NULL) { BLI_assert(!"CoW object part of RBW constraints collection without RB constraint data, " diff --git a/source/blender/blenkernel/intern/scene.c b/source/blender/blenkernel/intern/scene.c index 84741038164..f8f4d52fcf2 100644 --- a/source/blender/blenkernel/intern/scene.c +++ b/source/blender/blenkernel/intern/scene.c @@ -192,7 +192,7 @@ static void scene_init_data(ID *id) BLI_strncpy(scene->r.pic, U.renderdir, sizeof(scene->r.pic)); - /* Note; in header_info.c the scene copy happens..., + /* NOTE: in header_info.c the scene copy happens..., * if you add more to renderdata it has to be checked there. */ /* multiview - stereo */ @@ -1045,7 +1045,7 @@ static void scene_blend_write(BlendWriter *writer, ID *id, const void *id_addres static void direct_link_paint_helper(BlendDataReader *reader, const Scene *scene, Paint **paint) { - /* TODO. is this needed */ + /* TODO: is this needed. */ BLO_read_data_address(reader, paint); if (*paint) { @@ -1899,14 +1899,14 @@ void BKE_scene_copy_data_eevee(Scene *sce_dst, const Scene *sce_src) sce_dst->eevee = sce_src->eevee; sce_dst->eevee.light_cache_data = NULL; sce_dst->eevee.light_cache_info[0] = '\0'; - /* TODO Copy the cache. */ + /* TODO: Copy the cache. */ } Scene *BKE_scene_duplicate(Main *bmain, Scene *sce, eSceneCopyMethod type) { Scene *sce_copy; - /* TODO this should/could most likely be replaced by call to more generic code at some point... + /* TODO: this should/could most likely be replaced by call to more generic code at some point... * But for now, let's keep it well isolated here. */ if (type == SCE_COPY_EMPTY) { ListBase rv; diff --git a/source/blender/blenkernel/intern/screen.c b/source/blender/blenkernel/intern/screen.c index 608317933f5..a2809543b95 100644 --- a/source/blender/blenkernel/intern/screen.c +++ b/source/blender/blenkernel/intern/screen.c @@ -101,7 +101,7 @@ void BKE_screen_foreach_id_screen_area(LibraryForeachIDData *data, ScrArea *area { BKE_LIB_FOREACHID_PROCESS(data, area->full, IDWALK_CB_NOP); - /* TODO this should be moved to a callback in `SpaceType`, defined in each editor's own code. + /* TODO: this should be moved to a callback in `SpaceType`, defined in each editor's own code. * Will be for a later round of cleanup though... */ LISTBASE_FOREACH (SpaceLink *, sl, &area->spacedata) { switch (sl->spacetype) { @@ -289,7 +289,7 @@ bool BKE_screen_blend_read_data(BlendDataReader *reader, bScreen *screen) return success; } -/* note: file read without screens option G_FILE_NO_UI; +/* NOTE: file read without screens option G_FILE_NO_UI; * check lib pointers in call below */ static void screen_blend_read_lib(BlendLibReader *reader, ID *id) { diff --git a/source/blender/blenkernel/intern/shader_fx.c b/source/blender/blenkernel/intern/shader_fx.c index b537bdc5479..29cbe05f4d1 100644 --- a/source/blender/blenkernel/intern/shader_fx.c +++ b/source/blender/blenkernel/intern/shader_fx.c @@ -81,7 +81,7 @@ ShaderFxData *BKE_shaderfx_new(int type) const ShaderFxTypeInfo *fxi = BKE_shaderfx_get_info(type); ShaderFxData *fx = MEM_callocN(fxi->struct_size, fxi->struct_name); - /* note, this name must be made unique later */ + /* NOTE: this name must be made unique later. */ BLI_strncpy(fx->name, DATA_(fxi->name), sizeof(fx->name)); fx->type = type; diff --git a/source/blender/blenkernel/intern/shrinkwrap.c b/source/blender/blenkernel/intern/shrinkwrap.c index aeb8133974e..dd6a6ddca86 100644 --- a/source/blender/blenkernel/intern/shrinkwrap.c +++ b/source/blender/blenkernel/intern/shrinkwrap.c @@ -1440,7 +1440,7 @@ void shrinkwrapModifier_deform(ShrinkwrapModifierData *smd, Object *ob_target = DEG_get_evaluated_object(ctx->depsgraph, smd->target); calc.target = BKE_modifier_get_evaluated_mesh_from_evaluated_object(ob_target, false); - /* TODO there might be several "bugs" with non-uniform scales matrices + /* TODO: there might be several "bugs" with non-uniform scales matrices * because it will no longer be nearest surface, not sphere projection * because space has been deformed */ BLI_SPACE_TRANSFORM_SETUP(&calc.local2target, ob, ob_target); @@ -1460,7 +1460,7 @@ void shrinkwrapModifier_deform(ShrinkwrapModifierData *smd, ssmd.subdivType = ME_CC_SUBSURF; /* catmull clark */ ssmd.levels = smd->subsurfLevels; /* levels */ - /* TODO to be moved to Mesh once we are done with changes in subsurf code. */ + /* TODO: to be moved to Mesh once we are done with changes in subsurf code. */ DerivedMesh *dm = CDDM_from_mesh(mesh); ss_mesh = subsurf_make_derived_from_derived( diff --git a/source/blender/blenkernel/intern/softbody.c b/source/blender/blenkernel/intern/softbody.c index 9d871777c61..c44c339655c 100644 --- a/source/blender/blenkernel/intern/softbody.c +++ b/source/blender/blenkernel/intern/softbody.c @@ -1907,7 +1907,7 @@ static void sb_spring_force( #endif } else { - /* TODO make this debug option */ + /* TODO: make this debug option. */ CLOG_WARN(&LOG, "bodypoint is not attached to spring <*bs>"); return; } diff --git a/source/blender/blenkernel/intern/subsurf_ccg.c b/source/blender/blenkernel/intern/subsurf_ccg.c index 0dbfeaaaadb..cff2c5cc562 100644 --- a/source/blender/blenkernel/intern/subsurf_ccg.c +++ b/source/blender/blenkernel/intern/subsurf_ccg.c @@ -2352,7 +2352,7 @@ struct DerivedMesh *subsurf_make_derived_from_derived(struct DerivedMesh *dm, const bool ignore_simplify = (flags & SUBSURF_IGNORE_SIMPLIFY); CCGDerivedMesh *result; - /* note: editmode calculation can only run once per + /* NOTE: editmode calculation can only run once per * modifier stack evaluation (uses freed cache) T36299. */ if (flags & SUBSURF_FOR_EDIT_MODE) { int levels = (scene != NULL && !ignore_simplify) ? diff --git a/source/blender/blenkernel/intern/text.c b/source/blender/blenkernel/intern/text.c index 74845e3f1b9..80ff8ce9162 100644 --- a/source/blender/blenkernel/intern/text.c +++ b/source/blender/blenkernel/intern/text.c @@ -176,7 +176,7 @@ static void text_blend_write(BlendWriter *writer, ID *id, const void *id_address } Text *text = (Text *)id; - /* Note: we are clearing local temp data here, *not* the flag in the actual 'real' ID. */ + /* NOTE: we are clearing local temp data here, *not* the flag in the actual 'real' ID. */ if ((text->flags & TXT_ISMEM) && (text->flags & TXT_ISEXT)) { text->flags &= ~TXT_ISEXT; } @@ -2397,7 +2397,7 @@ int text_check_bracket(const char ch) return 0; } -/* TODO, have a function for operators - +/* TODO: have a function for operators - * http://docs.python.org/py3k/reference/lexical_analysis.html#operators */ bool text_check_delim(const char ch) { diff --git a/source/blender/blenkernel/intern/tracking_stabilize.c b/source/blender/blenkernel/intern/tracking_stabilize.c index 3dff750edfb..d5585116f7e 100644 --- a/source/blender/blenkernel/intern/tracking_stabilize.c +++ b/source/blender/blenkernel/intern/tracking_stabilize.c @@ -376,7 +376,7 @@ static MovieTrackingMarker *get_tracking_data_point(StabContext *ctx, * always guesswork. * * As a simple default, we use the weighted average of the location markers - * of the current frame as pivot point. TODO It is planned to add further + * of the current frame as pivot point. TODO: It is planned to add further * options, like e.g. anchoring the pivot point at the canvas. Moreover, * it is planned to allow for a user controllable offset. */ @@ -661,7 +661,7 @@ static void average_marker_positions(StabContext *ctx, int framenr, float r_ref_ int next_higher = MAXFRAME; use_values_from_fcurves(ctx, true); LISTBASE_FOREACH (MovieTrackingTrack *, track, &tracking->tracks) { - /* Note: we deliberately do not care if this track + /* NOTE: we deliberately do not care if this track * is already initialized for stabilization. */ if (track->flag & TRACK_USE_2D_STAB) { int startpoint = search_closest_marker_index(track, framenr); diff --git a/source/blender/blenkernel/intern/undo_system.c b/source/blender/blenkernel/intern/undo_system.c index 14dd286a315..fe2aa701c63 100644 --- a/source/blender/blenkernel/intern/undo_system.c +++ b/source/blender/blenkernel/intern/undo_system.c @@ -140,7 +140,7 @@ static void undosys_id_ref_store(void *UNUSED(user_data), UndoRefID *id_ref) static void undosys_id_ref_resolve(void *user_data, UndoRefID *id_ref) { - /* Note: we could optimize this, + /* NOTE: we could optimize this, * for now it's not too bad since it only runs when we access undo! */ Main *bmain = user_data; ListBase *lb = which_libbase(bmain, GS(id_ref->name)); diff --git a/source/blender/blenkernel/intern/unit.c b/source/blender/blenkernel/intern/unit.c index 290b880934e..f87f1c0428b 100644 --- a/source/blender/blenkernel/intern/unit.c +++ b/source/blender/blenkernel/intern/unit.c @@ -917,7 +917,7 @@ static int unit_scale_str(char *str, return 0; } - /* XXX - investigate, does not respect len_max properly. */ + /* XXX: investigate, does not respect len_max properly. */ char *str_found = (char *)unit_find_str(str, replace_str, case_sensitive); if (str_found == NULL) { @@ -931,7 +931,7 @@ static int unit_scale_str(char *str, /* Deal with unit bias for temperature units. Order of operations is important, so we * have to add parentheses, add the bias, then multiply by the scalar like usual. * - * Note: If these changes don't fit in the buffer properly unit evaluation has failed, + * NOTE: If these changes don't fit in the buffer properly unit evaluation has failed, * just try not to destroy anything while failing. */ if (unit->bias != 0.0) { /* Add the open parenthesis. */ diff --git a/source/blender/blenkernel/intern/volume.cc b/source/blender/blenkernel/intern/volume.cc index 272ecc71833..b28d17df814 100644 --- a/source/blender/blenkernel/intern/volume.cc +++ b/source/blender/blenkernel/intern/volume.cc @@ -197,7 +197,7 @@ static struct VolumeFileCache { Entry &entry = (Entry &)*it; entry.num_metadata_users++; - /* Note: pointers to unordered_set values are not invalidated when adding + /* NOTE: pointers to unordered_set values are not invalidated when adding * or removing other values. */ return &entry; } -- cgit v1.2.3