Docs: function comments
[blender.git] / doc / doxygen / doxygen.source.h
1
2 /** \defgroup blenderplayer Blender Player */
3
4 /** \defgroup blc bad level calls
5  *  \ingroup blenderplayer
6  */
7
8 /** \defgroup render Rendering
9  *  \ingroup blender
10  */
11 /** \defgroup bmesh BMesh
12  *  \ingroup blender
13  */
14 /** \defgroup compositor Compositing */
15
16 /** \defgroup python Python
17  *  \ingroup blender
18  */
19
20 /** \defgroup pygen Python Generic
21  *  \ingroup python
22  */
23
24 /** \defgroup pymathutils Python Mathutils
25  *  \ingroup python
26  */
27
28 /** \defgroup pythonintern Python RNA and Operators
29  *  \ingroup python
30  */
31
32 /** \defgroup blpluginapi Blender pluginapi
33  *  \ingroup blender
34  *  \attention not in use currently
35  */
36
37 /* ================================ */
38
39 /** \defgroup bge Game Engine */
40 /** \defgroup gamelogic Game Logic
41  *  \ingroup bge
42  */
43 /** \defgroup bgeconv Converter
44  *  \ingroup bge
45  */
46 /** \defgroup blroutines Blender Routines
47  *  \ingroup bge
48  */
49 /** \defgroup expressions Expressions
50  *  \ingroup bge
51  */
52 /** \defgroup player Game Player
53  *  \ingroup bge
54  */
55 /** \defgroup ketsji Ketsji
56  *  \ingroup bge
57  *  \todo check all headers and code files for proper licenses
58  */
59 /** \defgroup ketsjinet Ketsji Network
60  *  \ingroup ketsji
61  */
62 /** \defgroup bgenet Network
63  *  \ingroup bge
64  */
65 /** \defgroup bgenetlb Loopback Network
66  *  \ingroup bgenet
67  */
68 /** \defgroup phys Physics
69  *  \ingroup bge
70  */
71 /** \defgroup physbullet Bullet Physics
72  *  \ingroup phys
73  */
74 /** \defgroup physdummy Dummy Physics (none)
75  *  \ingroup phys
76  */
77 /** \defgroup bgerast Rasterizer
78  *  \ingroup bge
79  */
80 /** \defgroup bgerastoglfilters OpenGL Filters
81  *  \ingroup bgerast
82  */
83 /** \defgroup bgerastogl OpenGL Rasterizer
84  *  \ingroup bgerast
85  */
86 /** \defgroup bgesg BGE SceneGraph
87  *  \ingroup bge
88  */
89 /** \defgroup bgevideotex BGE Video Texture
90  *  \ingroup bge
91  */
92
93 /* ================================ */
94
95 /** \defgroup blender Blender */
96
97 /** \defgroup blt BlenTranslation
98  *  \ingroup blender
99  */
100
101 /** \defgroup blf BlenFont
102  *  \ingroup blender
103  */
104
105 /** \defgroup bke BlenKernel
106  *  \ingroup blender
107  */
108
109 /** \defgroup bli BlenLib
110  *  \ingroup blender
111  */
112
113 /** \defgroup depsgraph Dependency Graph
114  *  \ingroup blender
115  */
116
117 /** \defgroup bph Physics
118  *  \ingroup blender
119  */
120
121 /** \defgroup nodes Nodes
122  *  \ingroup blender
123  */
124
125 /** \defgroup cmpnodes Nodes (Compositor)
126  *  \ingroup nodes
127  */
128
129 /** \defgroup shdnodes Nodes (Shader)
130  *  \ingroup nodes
131  */
132
133 /** \defgroup texnodes Nodes (Texture)
134  *  \ingroup nodes
135  */
136 /** \defgroup modifiers Object Modifiers
137  *  \ingroup blender
138  */
139
140 /** \defgroup data DNA, RNA and .blend access*/
141
142 /** \defgroup gpu GPU
143  *  \ingroup blender
144  */
145
146 /** \defgroup ikplugin IK Plugin
147  *  \ingroup blender
148  */
149
150 /** \defgroup DNA Struct DNA (File Format)
151  *  \ingroup blender data
152  */
153 /** \defgroup RNA RNA (Data API)
154  *  \ingroup blender data
155  */
156
157 /** \defgroup blenloader Blend file IO
158  *  \ingroup blender data
159  *  \todo check if \ref blo and \ref blenloader groups can be
160  *   merged in docs.
161  */
162
163 /** \defgroup quicktime QuickTime
164  *  \ingroup blender
165
166 /** \defgroup gui GUI */
167
168 /** \defgroup wm Window Manager
169  *  \ingroup blender gui
170  */
171
172 /* ================================ */
173
174 /** \defgroup editors Editors
175  *  \ingroup blender
176  */
177
178 /** \defgroup edanimation animation
179  *  \ingroup editors
180  */
181
182 /** \defgroup edarmature armature
183  *  \ingroup editors
184  */
185
186 /** \defgroup edcurve curve
187  *  \ingroup editors
188  */
189
190 /** \defgroup eddatafiles datafiles
191  *  \ingroup editors
192  */
193
194 /** \defgroup edgpencil gpencil
195  *  \ingroup editors
196  */
197
198 /** \defgroup edinterface interface
199  *  \ingroup editors
200  */
201
202 /** \defgroup edmesh mesh
203  *  \ingroup editors
204  */
205
206 /** \defgroup edmeta metaball
207  *  \ingroup editors
208  */
209
210 /** \defgroup edobj object
211  *  \ingroup editors
212  */
213
214 /** \defgroup edphys physics
215  *  \ingroup editors
216  */
217
218 /** \defgroup edrend render
219  *  \ingroup editors
220  */
221
222 /** \defgroup edscr screen
223  *  \ingroup editors
224  */
225
226 /** \defgroup edsculpt sculpt and paint
227  *  \ingroup editors
228  */
229
230 /** \defgroup edsnd sound
231  *  \ingroup editors
232  */
233
234 /** \defgroup spaction action space
235  *  \ingroup editors
236  */
237
238 /** \defgroup spapi space API
239  *  \ingroup editors
240  */
241
242 /** \defgroup spbuttons buttons space
243  *  \ingroup editors
244  */
245
246 /** \defgroup spconsole console space
247  *  \ingroup editors
248  */
249
250 /** \defgroup spfile fileselector
251  *  \ingroup editors
252  */
253
254 /** \defgroup spgraph graph editor
255  *  \ingroup editors
256  */
257
258 /** \defgroup spimage image and UV editor
259  *  \ingroup editors
260  */
261
262 /** \defgroup spinfo info space
263  *  \ingroup editors
264  */
265
266 /** \defgroup splogic game logic editor
267  *  \ingroup editors
268  */
269
270 /** \defgroup spnla NLA editor
271  *  \ingroup editors
272  */
273
274 /** \defgroup spnode node editor
275  *  \ingroup editors
276  */
277
278 /** \defgroup spoutliner outliner space
279  *  \ingroup editors
280  */
281
282 /** \defgroup spscript script space
283  *  \ingroup editors
284  */
285
286 /** \defgroup spseq sequencer
287  *  \ingroup editors
288  */
289
290 /** \defgroup spsnd sound space
291  *  \ingroup editors
292  */
293
294 /** \defgroup sptext text editor
295  *  \ingroup editors
296  */
297
298 /** \defgroup sptime time line
299  *  \ingroup editors
300  */
301
302 /** \defgroup spuserpref user preferences
303  *  \ingroup editors
304  */
305
306 /** \defgroup spview3d 3D view
307  *  \ingroup editors
308  */
309
310 /** \defgroup edtransform transform
311  *  \ingroup editors
312  */
313
314 /** \defgroup edutil editor utilities
315  *  \ingroup editors
316  */
317
318 /** \defgroup spuv UV editing
319  *  \ingroup editors
320  */
321
322 /* ================================ */
323
324 /** \defgroup editorui Interface and Widgets
325  *  \ingroup gui
326  */
327
328 /** \defgroup externformats External Formats */
329
330 /** \defgroup collada COLLADA
331  *  \ingroup externformats
332  */
333
334 /** \defgroup avi AVI
335  *  \ingroup externformats
336  */
337
338 /** \defgroup imbuf Image Buffer (ImBuf)
339  *  \ingroup blender
340  */
341
342 /** \defgroup imbcineon Cineon
343  *  \ingroup imbuf
344  */
345
346 /** \defgroup imbdds DDS
347  *  \ingroup imbuf
348  */
349
350 /** \defgroup openexr OpenEXR
351  *  \ingroup imbuf
352  */
353
354 /* ================================ */
355
356 /** \defgroup undoc Undocumented
357  *  \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */