7f03753d82daa47376608ab077766bf8535ccce1
[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  */
46
47 /** \defgroup blenderplayer Blender Player */
48
49 /** \defgroup render Rendering */
50 /** \defgroup meshedit Mesh Editing */
51 /** \defgroup texture Texturing */
52 /** \defgroup compositor Compositing */
53
54 /** \defgroup scripts Scripting */
55
56 /** \defgroup python Python
57  *  \ingroup scripts
58  */
59
60 /** \defgroup bge Game Engine */
61 /** \defgroup gamelogic Game Logic
62  *  \ingroup bge
63  */
64 /** \defgroup bgeconv Converter
65  *  \ingroup bge
66  */
67 /** \defgroup blroutines Blender Routines
68  *  \ingroup bge
69  */
70 /** \defgroup expressions Expressions
71  *  \ingroup bge
72  */
73 /** \defgroup player Game Player
74  *  \ingroup bge
75  */
76 /** \defgroup ketsji Ketsji
77  *  \ingroup bge
78  *  \todo check all headers and code files for proper licenses
79  */
80 /** \defgroup ketsjinet Ketsji Network
81  *  \ingroup ketsji
82  */
83 /** \defgroup bgenet Network
84  *  \ingroup bge
85  */
86 /** \defgroup bgenetlb Loopback Network
87  *  \ingroup bgenet
88  */
89 /** \defgroup phys Physics
90  *  \ingroup bge
91  */
92 /** \defgroup physbullet Bullet Physics
93  *  \ingroup phys
94  */
95 /** \defgroup physdummy Dummy Physics (none)
96  *  \ingroup phys
97  */
98 /** \defgroup bgerast Rasterizer
99  *  \ingroup bge
100  */
101 /** \defgroup bgerastoglfilters OpenGL Filters
102  *  \ingroup bgerast
103  */
104 /** \defgroup bgerastogl OpenGL Rasterizer
105  *  \ingroup bgerast
106  */
107
108 /** \defgroup audaspace Audaspace
109  *  \ingroup intern undoc
110  *  \todo add to doxygen
111  */
112
113 /** \defgroup core core */
114
115 /** \defgroup bke blenkernel
116  *  \ingroup core
117  */
118
119 /** \defgroup bli blenlib
120  *  \ingroup core
121  */
122
123 /** \defgroup nodes nodes
124  *  \ingroup core
125  */
126
127 /** \defgroup modifiers modifiers
128  *  \ingroup core
129  */
130
131 /** \defgroup data DNA, RNA and .blend access*/
132
133 /** \defgroup GHOST GHOST API
134  * \ingroup intern GUI
135  * \ref GHOSTPage
136  */
137
138 /** \defgroup gpu GPU */
139
140 /** \defgroup DNA sDNA
141  *  \ingroup data
142  */
143 /** \defgroup RNA RNA
144  *  \ingroup data
145  */
146
147 /** \defgroup readwrite .blend read and write functions
148  *  \ingroup data
149  */
150
151 /** \defgroup readblenfile readblenfile
152  *  \ingroup data
153  */
154
155 /** \defgroup gui GUI */
156
157 /** \defgroup wm windowmanager
158  *  \ingroup gui
159  */
160
161 /** \defgroup editors Editors */
162
163 /** \defgroup editorui Interface and Widgets
164  *  \ingroup gui
165  */
166
167 /** \defgroup externformats external formats */
168
169 /** \defgroup collada COLLADA
170  *  \ingroup externformats
171  */
172
173 /** \defgroup avi AVI
174  *  \ingroup externformats
175  */
176
177 /** \defgroup imbuf IMage Buffer */
178
179 /** \defgroup undoc Undocumented
180  *  \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */