Cleanup: spelling

This commit is contained in:
Campbell Barton 2021-01-20 15:24:52 +11:00
parent b2a6e2abdb
commit 255c850e0b
6 changed files with 24 additions and 15 deletions

View File

@ -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.

View File

@ -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;

View File

@ -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);

View File

@ -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

View File

@ -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;

View File

@ -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;