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