From 255c850e0be3c1ca8676e2dcdc316232f646da96 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Wed, 20 Jan 2021 15:24:52 +1100 Subject: Cleanup: spelling --- source/blender/blenkernel/intern/anim_sys.c | 7 ++++--- source/blender/blenkernel/intern/tracking.c | 8 +++++--- source/blender/blenlib/intern/voxel.c | 8 +++++--- source/blender/depsgraph/intern/node/deg_node_id.h | 4 ++-- source/blender/makesdna/DNA_dynamicpaint_types.h | 6 ++++-- source/blender/makesdna/DNA_modifier_types.h | 6 ++++-- 6 files changed, 24 insertions(+), 15 deletions(-) diff --git a/source/blender/blenkernel/intern/anim_sys.c b/source/blender/blenkernel/intern/anim_sys.c index 00c245a797f..da874539232 100644 --- a/source/blender/blenkernel/intern/anim_sys.c +++ b/source/blender/blenkernel/intern/anim_sys.c @@ -2357,9 +2357,10 @@ static bool is_action_track_evaluated_without_nla(const AnimData *adt, return true; } -/** XXX Wayde Moss: BKE_nlatrack_find_tweaked() exists within nla.c, but it doesn't appear to - * work as expected. From animsys_evaluate_nla_for_flush(), it returns NULL in tweak mode. I'm not - * sure why. Preferably, it would be as simple as checking for (adt->act_Track == nlt) but that +/** + * XXX(Wayde Moss): #BKE_nlatrack_find_tweaked() exists within nla.c, but it doesn't appear to + * work as expected. From #animsys_evaluate_nla_for_flush(), it returns NULL in tweak mode. I'm not + * sure why. Preferably, it would be as simple as checking for `(adt->act_Track == nlt)` but that * doesn't work either, neither does comparing indices. * * This function is a temporary work around. The first disabled track is always the tweaked track. diff --git a/source/blender/blenkernel/intern/tracking.c b/source/blender/blenkernel/intern/tracking.c index 7a7ff5e9acb..5353d0b9628 100644 --- a/source/blender/blenkernel/intern/tracking.c +++ b/source/blender/blenkernel/intern/tracking.c @@ -1482,14 +1482,16 @@ void BKE_tracking_marker_clamp(MovieTrackingMarker *marker, int event) } } -/* Get marker closest to the given frame number. +/** + * Get marker closest to the given frame number. * * If there is maker with exact frame number it returned. - * Otherwise, marker with higherst frame number but lower than the requested + * Otherwise, marker with highest frame number but lower than the requested * frame is returned if such marker exists. Otherwise, the marker with lowest * frame number greater than the requested frame number is returned. * - * This function has complexity of O(log number_of_markers). */ + * This function has complexity of `O(log number_of_markers)`. + */ MovieTrackingMarker *BKE_tracking_marker_get(MovieTrackingTrack *track, int framenr) { const int num_markers = track->markersnr; diff --git a/source/blender/blenlib/intern/voxel.c b/source/blender/blenlib/intern/voxel.c index eac01a0e2aa..c0c895654e3 100644 --- a/source/blender/blenlib/intern/voxel.c +++ b/source/blender/blenlib/intern/voxel.c @@ -54,12 +54,14 @@ BLI_INLINE int FLOORI(float x) return ((x >= 0.0f) || (float)r == x) ? r : (r - 1); } -/* clamp function, cannot use the CLAMPIS macro, +/** + * clamp function, cannot use the CLAMPIS macro, * it sometimes returns unwanted results apparently related to - * gcc optimization flag -fstrict-overflow which is enabled at -O2 + * gcc optimization flag `-fstrict-overflow` which is enabled at `-O2` * * this causes the test (x + 2) < 0 with int x == 2147483647 to return false (x being an integer, - * x + 2 should wrap around to -2147483647 so the test < 0 should return true, which it doesn't) */ + * x + 2 should wrap around to -2147483647 so the test < 0 should return true, which it doesn't). + */ BLI_INLINE int64_t _clamp(int a, int b, int c) { return (a < b) ? b : ((a > c) ? c : a); diff --git a/source/blender/depsgraph/intern/node/deg_node_id.h b/source/blender/depsgraph/intern/node/deg_node_id.h index c4d36685bb8..e2d3b3fc36f 100644 --- a/source/blender/depsgraph/intern/node/deg_node_id.h +++ b/source/blender/depsgraph/intern/node/deg_node_id.h @@ -88,7 +88,7 @@ struct IDNode : public Node { * which could be "stale" pointer. */ uint id_orig_session_uuid; - /* Evaluated datablock. + /* Evaluated data-block. * Will be covered by the copy-on-write system if the ID Type needs it. */ ID *id_cow; @@ -107,7 +107,7 @@ struct IDNode : public Node { eDepsNode_LinkedState_Type linked_state; - /* Indicates the datablock is visible in the evaluated scene. */ + /* Indicates the data-block is visible in the evaluated scene. */ bool is_directly_visible; /* For the collection type of ID, denotes whether collection was fully diff --git a/source/blender/makesdna/DNA_dynamicpaint_types.h b/source/blender/makesdna/DNA_dynamicpaint_types.h index c8e09225432..e3dcd283efa 100644 --- a/source/blender/makesdna/DNA_dynamicpaint_types.h +++ b/source/blender/makesdna/DNA_dynamicpaint_types.h @@ -242,10 +242,12 @@ typedef struct DynamicPaintBrushSettings { /** For fast RNA access. */ struct DynamicPaintModifierData *pmd; - /* NOTE: Storing the particle system pointer here is very weak, as it prevents modfiers' data + /** + * \note Storing the particle system pointer here is very weak, as it prevents modifiers' data * copying to be self-sufficient (extra external code needs to ensure the pointer remains valid * when the modifier data is copied from one object to another). See e.g. - * `BKE_object_copy_particlesystems` or `BKE_object_copy_modifier`. */ + * `BKE_object_copy_particlesystems` or `BKE_object_copy_modifier`. + */ struct ParticleSystem *psys; int flags; diff --git a/source/blender/makesdna/DNA_modifier_types.h b/source/blender/makesdna/DNA_modifier_types.h index 3de4299e0bd..29421430e5d 100644 --- a/source/blender/makesdna/DNA_modifier_types.h +++ b/source/blender/makesdna/DNA_modifier_types.h @@ -984,10 +984,12 @@ enum { typedef struct ParticleSystemModifierData { ModifierData modifier; - /* NOTE: Storing the particle system pointer here is very weak, as it prevents modfiers' data + /** + * \note Storing the particle system pointer here is very weak, as it prevents modifiers' data * copying to be self-sufficient (extra external code needs to ensure the pointer remains valid * when the modifier data is copied from one object to another). See e.g. - * `BKE_object_copy_particlesystems` or `BKE_object_copy_modifier`. */ + * `BKE_object_copy_particlesystems` or `BKE_object_copy_modifier`. + */ struct ParticleSystem *psys; /** Final Mesh - its topology may differ from orig mesh. */ struct Mesh *mesh_final; -- cgit v1.2.3