diff options
author | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 09:12:40 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2021-12-08 09:12:40 +0300 |
commit | db795a4727b3a2ad56a11147181d5e3d60ca0466 (patch) | |
tree | 1c78acadb1fab2c9cc54df3baa214fdf90b3a2f4 /source/blender/makesrna/intern/rna_access_internal.h | |
parent | da67a19ed9b5e8c5f61926d88653c05ebd3cdf45 (diff) |
Cleanup: move public doc-strings into headers for 'makesrna'
Ref T92709
Diffstat (limited to 'source/blender/makesrna/intern/rna_access_internal.h')
-rw-r--r-- | source/blender/makesrna/intern/rna_access_internal.h | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/source/blender/makesrna/intern/rna_access_internal.h b/source/blender/makesrna/intern/rna_access_internal.h index 73407123863..9f1be5bbd67 100644 --- a/source/blender/makesrna/intern/rna_access_internal.h +++ b/source/blender/makesrna/intern/rna_access_internal.h @@ -27,6 +27,13 @@ struct IDProperty; struct PropertyRNAOrID; +/** + * This function initializes a #PropertyRNAOrID with all required info, from a given #PropertyRNA + * and #PointerRNA data. It deals properly with the three cases + * (static RNA, runtime RNA, and #IDProperty). + * \warning given `ptr` #PointerRNA is assumed to be a valid data one here, calling code is + * responsible to ensure that. + */ void rna_property_rna_or_id_get(PropertyRNA *prop, PointerRNA *ptr, PropertyRNAOrID *r_prop_rna_or_id); |