diff options
author | Campbell Barton <campbell@blender.org> | 2022-03-01 01:09:24 +0300 |
---|---|---|
committer | Campbell Barton <campbell@blender.org> | 2022-03-01 01:36:25 +0300 |
commit | 5777bd719b01f56e52d618a3260bd4cdf223d5cd (patch) | |
tree | f0f9e80c3a44ca542939ee03010b66a255fd01e7 /source/blender/makesdna/DNA_userdef_enums.h | |
parent | 94a4dddb1b64ec0912b7b2ac5b2264e86cd3d955 (diff) |
Cleanup: use doxygen comments, correct spelling
Also move eDupli_ID_Flags doc-string to it's declaration.
Diffstat (limited to 'source/blender/makesdna/DNA_userdef_enums.h')
-rw-r--r-- | source/blender/makesdna/DNA_userdef_enums.h | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/source/blender/makesdna/DNA_userdef_enums.h b/source/blender/makesdna/DNA_userdef_enums.h index bb061e73c9c..e90aa0e0f07 100644 --- a/source/blender/makesdna/DNA_userdef_enums.h +++ b/source/blender/makesdna/DNA_userdef_enums.h @@ -10,7 +10,14 @@ extern "C" { #endif -/** #UserDef.dupflag */ +/** + * #UserDef.dupflag + * + * The flag tells #BKE_object_duplicate() whether to copy data linked to the object, + * or to reference the existing data. + * #U.dupflag should be used for default operations or you can construct a flag as Python does. + * If #eDupli_ID_Flags is 0 then no data will be copied (linked duplicate). + */ typedef enum eDupli_ID_Flags { USER_DUP_MESH = (1 << 0), USER_DUP_CURVE = (1 << 1), |