From e0109604319739e2bc62b7ecf868fea9e1192b60 Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Fri, 8 May 2015 06:46:16 +1000 Subject: DNA; document how to ignore a struct --- source/blender/makesdna/DNA_documentation.h | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) (limited to 'source/blender/makesdna/DNA_documentation.h') 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 -- cgit v1.2.3