Initial revision
[blender.git] / source / blender / makesdna / DNA_documentation.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL/BL DUAL 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. The Blender
10  * Foundation also sells licenses for use in proprietary software under
11  * the Blender License.  See http://www.blender.org/BL/ for information
12  * about this.
13  *
14  * This program is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
22  *
23  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
24  * All rights reserved.
25  *
26  * The Original Code is: all of this file.
27  *
28  * Contributor(s): none yet.
29  *
30  * ***** END GPL/BL DUAL LICENSE BLOCK *****
31  *
32  * @mainpage DNA- Makesdna modules 
33  *
34  * @section about 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 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 issues 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::returnfuncmay still
50  *   be badly defined. The reason for this is that is 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 dependencies Dependencies
62  *
63  * DNA has no external dependencies (except for a few system
64  * includes).
65  *
66  **/
67
68 /* This file has intentionally no definitions or implementation. */