Merge branch 'master' into blender2.8
[blender.git] / source / blender / makesdna / DNA_documentation.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * The Original Code is: all of this file.
22  *
23  * Contributor(s): none yet.
24  *
25  * ***** END GPL LICENSE BLOCK *****
26  */
27
28 /**
29  *  \page makesdna makesdna
30  *  \ingroup DNA
31  *
32  * \section aboutdna About the DNA module
33  *
34  * The DNA module holds all type definitions that are serialized in a
35  * blender file. There is an executable that scans all files, looking
36  * for struct-s to serialize (hence sdna: Struct \ref DNA). From this
37  * information, it builds a file with numbers that encode the format,
38  * the names of variables, and the plce to look for them.
39  *
40  * \section dnaissues Known issues with DNA
41  *
42  * - Function pointers:
43  *
44  *   Because of historical reasons, some function pointers were
45  *   untyped. The parser/dna generator has been modified to explicitly
46  *   handle these special cases. Most pointers have been given proper
47  *   proto's by now. DNA_space_types.h::Spacefile::returnfunc may still
48  *   be badly defined. The reason for this is that it is called with
49  *   different types of arguments. It takes a char* at this moment...
50  *
51  * - Ignoring structs:
52  *
53  *   Sometimes we need to define structs in DNA which aren't written
54  *   to disk, and can be excluded from blend file DNA string.
55  *   in this case, add two '#' chars directly before the struct. eg.
56  *
57  *   \code{.c}
58  *   #
59  *   #
60  *   typedef struct MyStruct {
61  *       int value;
62  *   } MyStruct;
63  *   \endcode
64  *
65  *   Ignored structs can only be referred to from non-ignored structs
66  *   when referred to as a pointer (where they're usually allocated
67  *   and cleared in ``readfile.c``).
68  *
69  * - %Path to the header files
70  *
71  *   Also because of historical reasons, there is a path prefix to the
72  *   headers that need to be scanned. This is the BASE_HEADER
73  *   define. If you change the file-layout for DNA, you will probably
74  *   have to change this (Not very flexible, but it is hardly ever
75  *   changed. Sorry.).
76  *
77  * \section dnadependencies Dependencies
78  *
79  * DNA has no external dependencies (except for a few system
80  * includes).
81  *
82  * \section dnanote NOTE
83  *
84  * PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN
85  *
86  * intern/dna_genfile.c
87  * (ton)
88  *
89  */
90
91
92 /* This file has intentionally no definitions or implementation. */