diff options
author | Campbell Barton <ideasman42@gmail.com> | 2015-05-07 23:46:16 +0300 |
---|---|---|
committer | Campbell Barton <ideasman42@gmail.com> | 2015-05-07 23:54:13 +0300 |
commit | e0109604319739e2bc62b7ecf868fea9e1192b60 (patch) | |
tree | 117add6baea6be77cc1deec7a4eaed5d957eb262 /source/blender | |
parent | 0a82c3cfefa64a7c0bdafb4ef34600142e411616 (diff) |
DNA; document how to ignore a struct
Diffstat (limited to 'source/blender')
-rw-r--r-- | source/blender/makesdna/DNA_documentation.h | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/source/blender/makesdna/DNA_documentation.h b/source/blender/makesdna/DNA_documentation.h index 0dd7f37f8b4..0a0d46d70ff 100644 --- a/source/blender/makesdna/DNA_documentation.h +++ b/source/blender/makesdna/DNA_documentation.h @@ -48,6 +48,24 @@ * be badly defined. The reason for this is that it is called with * different types of arguments. It takes a char* at this moment... * + * - Ignoring structs: + * + * Sometimes we need to define structs in DNA which aren't written + * to disk, and can be excluded from blend file DNA string. + * in this case, add two '#' chars directly before the struct. eg. + * + * \code{.c} + * # + * # + * typedef struct MyStruct { + * int value; + * } MyStruct; + * \endcode + * + * Ignored structs can only be referred to from non-ignored structs + * when referred to as a pointer (where they're usually allocated + * and cleared in ``readfile.c``). + * * - %Path to the header files * * Also because of historical reasons, there is a path prefix to the |