fixed spacing in the headers to get rid of some warnings and some other
[blender.git] / source / blender / blenpluginapi / 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 plugin API - the access point for texture and sequence
33  * plugins
34  *
35  * @section about About the plugin API
36  *
37  * This API wraps functions that are used by texture and sequence
38  * plugins. They are explicitly wrapped in order to make the
39  * dependencies to the rest of the system clear.
40  *
41  * @section issues Known issues with the plugin API
42  *
43  * - It can be difficult at times to get access to the API functions
44  * linked into the final executable. On gcc, the -fpic and -shared
45  * flags take care of this. On Irix, -shared is needed, but you also
46  * need a reference to the function to get the handle. This has
47  * momentarily been taken care of by pluginapi_force_ref().
48  *
49  * - Plugins need to define three functions that are needed for
50  * version bookkeeping and information. The plugin loading code
51  * explicitly checks for these functions. The nanes depend on whether
52  * it is a texture or sequence plugin.
53  *
54  * - The plugin loading occurs in sequence.c and texture.c. The
55  * following functions are involved:
56  *   - open_plugin_seq() (used in readfile.c, editseq.c, sequence.c)
57  *   - add_plugin_seq()  (used in editseq.c, sequence.c)
58  *   - free_plugin_seq() (used in editseq.c, sequence.c)
59  *   - open_plugin_tex() (used in texture.c, readfile.c)
60  *   - add_plugin_tex()  (used in texture.c, buttons.c)
61  *   - free_plugin_tex() (used in texture.c, buttons.c)
62  *   - test_dlerr()      (used in texture.c, sequence.c)
63  * Since the plugins are about to phase out, we will not sanitize this
64  * code. It will be removed as soon as the replacing system is in
65  * place.
66  * 
67  * @section dependencies Dependencies
68  *
69  * The plugins wraps functions from IMB and BLI. In addition, they
70  * define some useful variables.
71  * */
72