diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-08-14 10:30:32 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-08-14 10:40:55 +0300 |
commit | fdfd87f2f4e656b2292683c923156dd9ea96512b (patch) | |
tree | 86d07941ef0b1111b477e60311b0193ba4f3fef4 /source/blender/makesdna | |
parent | 3fa0a1a5bc0ff28328930ee12608497262b25912 (diff) |
Docs: comment BHead.code values
Diffstat (limited to 'source/blender/makesdna')
-rw-r--r-- | source/blender/makesdna/DNA_ID.h | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/source/blender/makesdna/DNA_ID.h b/source/blender/makesdna/DNA_ID.h index 88e728c0e37..429679f6e4e 100644 --- a/source/blender/makesdna/DNA_ID.h +++ b/source/blender/makesdna/DNA_ID.h @@ -201,7 +201,12 @@ typedef struct PreviewImage { # define MAKE_ID2(c, d) ((d) << 8 | (c)) #endif -/* ID from database */ +/** + * ID from database. + * + * Written to #BHead.code (for file IO) + * and the first 2 bytes of #ID.name (for runtime checks, see #GS macro). + */ #define ID_SCE MAKE_ID2('S', 'C') /* Scene */ #define ID_LI MAKE_ID2('L', 'I') /* Library */ #define ID_OB MAKE_ID2('O', 'B') /* Object */ |