diff options
author | Campbell Barton <campbell@blender.org> | 2022-06-07 14:22:11 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-06-07 14:22:55 +0300 |
commit | 2918a3a2a374d9ad98923e9f6824534d7872c83f (patch) | |
tree | d45f6b30cb7cd2719952e3c746c2e7384c20dfd8 /source/blender/blenkernel/BKE_fcurve.h | |
parent | 1e0e1ad20f07990e8a48020dc944d414b5588ae6 (diff) |
Cleanup: spelling in comments, minor formatting tweaks
Diffstat (limited to 'source/blender/blenkernel/BKE_fcurve.h')
-rw-r--r-- | source/blender/blenkernel/BKE_fcurve.h | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/source/blender/blenkernel/BKE_fcurve.h b/source/blender/blenkernel/BKE_fcurve.h index 30c73e0fcc6..4489527fcab 100644 --- a/source/blender/blenkernel/BKE_fcurve.h +++ b/source/blender/blenkernel/BKE_fcurve.h @@ -263,14 +263,14 @@ struct FCurve *BKE_fcurve_iter_step(struct FCurve *fcu_iter, const char rna_path * If there is an action assigned to the `id`'s #AnimData, it will be searched for a matching * F-curve first. Drivers are searched only if no valid action F-curve could be found. * - * \note: Return pointer parameter (`r_driven`) is optional and may be NULL. + * \note Return pointer parameter (`r_driven`) is optional and may be NULL. * - * \warning: In case no animation (from an Action) F-curve is found, returned value is always NULL. + * \warning In case no animation (from an Action) F-curve is found, returned value is always NULL. * This means that this function will set `r_driven` to True in case a valid driver F-curve is * found, but will not return said F-curve. In other words: - * - Animated with FCurve: returns the `FCurve*` and `*r_driven = false`. - * - Animated with driver: returns `NULL` and `*r_driven = true`. - * - Not animated: returns `NULL` and `*r_driven = false`. + * - Animated with FCurve: returns the `FCurve*` and `*r_driven = false`. + * - Animated with driver: returns `NULL` and `*r_driven = true`. + * - Not animated: returns `NULL` and `*r_driven = false`. */ struct FCurve *id_data_find_fcurve( ID *id, void *data, struct StructRNA *type, const char *prop_name, int index, bool *r_driven); @@ -296,11 +296,11 @@ int BKE_fcurves_filter(ListBase *dst, ListBase *src, const char *dataPrefix, con * If there is an action assigned to the `animdata`, it will be searched for a matching F-curve * first. Drivers are searched only if no valid action F-curve could be found. * - * \note: Typically, indices in RNA arrays are stored separately in F-curves, so the rna_path + * \note Typically, indices in RNA arrays are stored separately in F-curves, so the rna_path * should not include them (e.g. `rna_path='location[0]'` will not match any F-Curve on an Object, * but `rna_path='location', rna_index=0` will if it exists). * - * \note: Return pointer parameters (`r_action`, `r_driven` and `r_special`) are all optional and + * \note Return pointer parameters (`r_action`, `r_driven` and `r_special`) are all optional and * may be NULL. */ struct FCurve *BKE_animadata_fcurve_find_by_rna_path(struct AnimData *animdata, |