doxygen: bge scenegraph and videotexture
[blender-staging.git] / doc / doxygen.main
1 /** \mainpage Blender
2  *
3  * \section intro Introduction
4  *
5  * Blender is an integrated 3d package.
6  *
7  * These pages document the source code of blender.
8  *
9  * \subsection implinks Important Links
10  * - <a href="http://projects.blender.org">projects.blender.org</a> with <a href="http://projects.blender.org/tracker/index.php?group_id=9&atid=498">bug tracker</a>
11  * - <a href="http://wiki.blender.org/index.php/Dev:Contents">Development documents</a> on our wiki.
12  *
13  * \subsection blother Other
14  * For more information on using Blender browse to http://www.blender.org
15  *
16  */
17
18 /** \defgroup intern Internal libraries
19  *  \section internabout Internal libraries
20  *  Blender comes with some of its dependencies
21  *  directly included in the codebase. Libraries
22  *  that are in the \c intern/ folder are maintained
23  *  as part of the normal development process.
24  */
25
26 /** \defgroup MEM Guarded memory (de)allocation
27  *  \ingroup intern
28  */
29
30 /** \defgroup extern External libraries
31  *  \section externabout External libraries
32  *  As with \ref intern these libraries are
33  *  provided in the Blender codebase. This is
34  *  to make building Blender easier. The main
35  *  development of these libraries is \b not part
36  *  of the normal Blender development process, but
37  *  each of the library is developed separately.
38  *  Whenever deemed necessary libraries in \c extern/
39  *  folder are updated.
40  *
41  */
42
43 /** \defgroup bullet Bullet Physics Library
44  *  \ingroup extern
45  *  \see \ref bulletdoc
46  */
47
48 /** \defgroup blenderplayer Blender Player */
49
50 /** \defgroup render Rendering */
51 /** \defgroup meshedit Mesh Editing */
52 /** \defgroup texture Texturing */
53 /** \defgroup compositor Compositing */
54
55 /** \defgroup scripts Scripting */
56
57 /** \defgroup python Python
58  *  \ingroup scripts
59  */
60
61 /** \defgroup bge Game Engine */
62 /** \defgroup gamelogic Game Logic
63  *  \ingroup bge
64  */
65 /** \defgroup bgeconv Converter
66  *  \ingroup bge
67  */
68 /** \defgroup blroutines Blender Routines
69  *  \ingroup bge
70  */
71 /** \defgroup expressions Expressions
72  *  \ingroup bge
73  */
74 /** \defgroup player Game Player
75  *  \ingroup bge
76  */
77 /** \defgroup ketsji Ketsji
78  *  \ingroup bge
79  *  \todo check all headers and code files for proper licenses
80  */
81 /** \defgroup ketsjinet Ketsji Network
82  *  \ingroup ketsji
83  */
84 /** \defgroup bgenet Network
85  *  \ingroup bge
86  */
87 /** \defgroup bgenetlb Loopback Network
88  *  \ingroup bgenet
89  */
90 /** \defgroup phys Physics
91  *  \ingroup bge
92  */
93 /** \defgroup physbullet Bullet Physics
94  *  \ingroup phys
95  */
96 /** \defgroup physdummy Dummy Physics (none)
97  *  \ingroup phys
98  */
99 /** \defgroup bgerast Rasterizer
100  *  \ingroup bge
101  */
102 /** \defgroup bgerastoglfilters OpenGL Filters
103  *  \ingroup bgerast
104  */
105 /** \defgroup bgerastogl OpenGL Rasterizer
106  *  \ingroup bgerast
107  */
108 /** \defgroup bgesg BGE SceneGraph
109  *  \ingroup bge
110  */
111 /** \defgroup bgevideotex BGE Video Texture
112  *  \ingroup bge
113  */
114
115 /** \defgroup audaspace Audaspace
116  *  \ingroup intern undoc
117  *  \todo add to doxygen
118  */
119
120 /** \defgroup core core */
121
122 /** \defgroup bke blenkernel
123  *  \ingroup core
124  */
125
126 /** \defgroup bli blenlib
127  *  \ingroup core
128  */
129
130 /** \defgroup nodes nodes
131  *  \ingroup core
132  */
133
134 /** \defgroup modifiers modifiers
135  *  \ingroup core
136  */
137
138 /** \defgroup data DNA, RNA and .blend access*/
139
140 /** \defgroup GHOST GHOST API
141  * \ingroup intern GUI
142  * \ref GHOSTPage
143  */
144
145 /** \defgroup gpu GPU */
146
147 /** \defgroup DNA sDNA
148  *  \ingroup data
149  */
150 /** \defgroup RNA RNA
151  *  \ingroup data
152  */
153
154 /** \defgroup readwrite .blend read and write functions
155  *  \ingroup data
156  */
157
158 /** \defgroup readblenfile readblenfile
159  *  \ingroup data
160  */
161
162 /** \defgroup gui GUI */
163
164 /** \defgroup wm windowmanager
165  *  \ingroup gui
166  */
167
168 /** \defgroup editors Editors */
169
170 /** \defgroup editorui Interface and Widgets
171  *  \ingroup gui
172  */
173
174 /** \defgroup externformats external formats */
175
176 /** \defgroup collada COLLADA
177  *  \ingroup externformats
178  */
179
180 /** \defgroup avi AVI
181  *  \ingroup externformats
182  */
183
184 /** \defgroup imbuf IMage Buffer */
185
186 /** \defgroup undoc Undocumented
187  *  \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */