Bring blenloader module under data group. Rename the group to look a bit more sensibl...
[blender.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  * For more information on using Blender browse to http://www.blender.org
10  *
11  * \section sects Main sections of the blender code
12  *
13  *  The following sections are the broad categories into which the various modules
14  *  belong.
15  *
16  *  - \ref render
17  *  - \ref meshedit
18  *  - \ref texture
19  *  - \ref compositor
20  *  - \ref scripts
21  *  - \ref gameengine
22  *  - \ref data
23  *
24  * \section GUI
25  *  - \ref gui
26  *
27  * \section libraries Libraries and Wrappers
28  *  - \ref GHOST
29  *  - \ref imbuf
30  *  - \ref audaspace
31  *  - \ref DNA
32  *  - \ref RNA
33  *
34  * \section Miscellaneous
35  *  - \ref undoc
36  */
37
38 /** \defgroup intern Internal libraries
39  *  \section internabout Internal libraries
40  *  Blender comes with some of its dependencies
41  *  directly included in the codebase. Libraries
42  *  that are in the \c intern/ folder are maintained
43  *  as part of the normal development process.
44  */
45
46 /** \defgroup extern External libraries
47  *  \section externabout External libraries
48  *  As with \ref intern these libraries are
49  *  provided in the Blender codebase. This is
50  *  to make building Blender easier. The main
51  *  development of these libraries is \b not part
52  *  of the normal Blender development process, but
53  *  each of the library is developed separately.
54  *  Whenever deemed necessary libraries in \c extern/
55  *  folder are updated.
56  *
57  */
58 /** \defgroup editors Editor modules */
59 /** \defgroup blenderplayer Blender Player */
60
61 /** \defgroup render Rendering Module */
62 /** \defgroup meshedit Mesh Editing Module */
63 /** \defgroup texture Texturing */
64 /** \defgroup compositor Compositing */
65
66 /** \defgroup scripts Scripting */
67
68 /** \defgroup gameengine Game Engine */
69
70 /** \defgroup audaspace Audaspace
71  *  \ingroup intern undoc
72  *  \todo add to doxygen
73  */
74
75 /** \defgroup data DNA, RNA and .blend access*/
76
77 /** \defgroup GHOST GHOST API */
78
79 /** \defgroup DNA sDNA
80  *  \ingroup data
81  */
82 /** \defgroup RNA RNA
83  *  \ingroup data
84  */
85
86 /** \defgroup readwrite .blend read and write functions
87  *  \ingroup data
88  */
89
90 /** \defgroup gui GUI */
91
92 /** \defgroup wm windowmanager
93  *  \ingroup gui
94  */
95
96 /** \defgroup imbuf IMage Buffer */
97
98 /** \defgroup undoc Undocumented
99  *  \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */