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