own fix r34446, was incorrect, fixed properly now.
[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  * @mainpage DNA- Makesdna modules 
30  *
31  * @section about About the DNA module
32  *
33  * The DNA module holds all type definitions that are serialized in a
34  * blender file. There is an executable that scans all files, looking
35  * for struct-s to serialize (hence sdna: Struct DNA). From this
36  * information, it builds a file with numbers that encode the format,
37  * the names of variables, and the plce to look for them.
38  *
39  * @section issues Known issues with DNA
40  *
41  * - Function pointers:
42  *
43  *   Because of historical reasons, some function pointers were
44  *   untyped. The parser/dna generator has been modified to explicitly
45  *   handle these special cases. Most pointers have been given proper
46  *   proto's by now. DNA_space_types.h::Spacefile::returnfuncmay still
47  *   be badly defined. The reason for this is that it is called with
48  *   different types of arguments. It takes a char* at this moment...
49  *
50  * - Path to the header files
51  *
52  *   Also because of historical reasons, there is a path prefix to the
53  *   headers that need to be scanned. This is the BASE_HEADER
54  *   define. If you change the file-layout for DNA, you will probably
55  *   have to change this (Not very flexible, but it is hardly ever
56  *   changed. Sorry.).
57  *
58  * @section dependencies Dependencies
59  *
60  * DNA has no external dependencies (except for a few system
61  * includes).
62  *
63  **/
64
65
66 /* PLEASE READ INSTRUCTIONS ABOUT ADDING VARIABLES IN 'DNA' STRUCTS IN
67
68   intern/dna_genfile.c
69   (ton)
70
71  */
72
73
74
75 /* This file has intentionally no definitions or implementation. */
76