diff options
| author | Campbell Barton <ideasman42@gmail.com> | 2020-12-11 06:51:43 +0300 |
|---|---|---|
| committer | Campbell Barton <ideasman42@gmail.com> | 2020-12-11 07:32:14 +0300 |
| commit | ff6d7e907269c3e090d4234df6eb7e812c809050 (patch) | |
| tree | 20b4b07e39bd9cfcf2d788137e574d8d6391ffdd /source/blender/makesdna/DNA_anim_types.h | |
| parent | a4a42f3171c021f2f7eb28e1ed10873b3314587b (diff) | |
Cleanup: spelling, expand on FCurve.rna_path docstring
Diffstat (limited to 'source/blender/makesdna/DNA_anim_types.h')
| -rw-r--r-- | source/blender/makesdna/DNA_anim_types.h | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/source/blender/makesdna/DNA_anim_types.h b/source/blender/makesdna/DNA_anim_types.h index 17d41985f80..bfc72fdd45c 100644 --- a/source/blender/makesdna/DNA_anim_types.h +++ b/source/blender/makesdna/DNA_anim_types.h @@ -612,9 +612,13 @@ typedef struct FCurve { char _pad[3]; /* RNA - data link */ - /** If applicable, the index of the RNA-array item to get. */ + /** When the RNA property from `rna_path` is an array, use this to access the array index. */ int array_index; - /** RNA-path to resolve data-access. */ + /** + * RNA-path to resolve data-access, see: #RNA_path_resolve_property. + * + * \note String look-ups for collection and custom-properties are escaped using #BLI_str_escape. + */ char *rna_path; /* curve coloring (for editor) */ |