Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorCasey Corn <cmccad@yahoo.com>2003-05-24 04:10:39 +0400
committerCasey Corn <cmccad@yahoo.com>2003-05-24 04:10:39 +0400
commitf293d6d676a1e1a7c2d81364bfb53e15178365c6 (patch)
tree2b1b59a2d2d7fc680aae6f07dcac6413aee0b15b /doc/doxygen.main
parent609f5b7f9c6690933499cb6bb51d9176874fbd63 (diff)
This is the initial commit for the doxygen config file and the file which
defines the blender blender mainpage and the major module groups.
Diffstat (limited to 'doc/doxygen.main')
-rw-r--r--doc/doxygen.main52
1 files changed, 52 insertions, 0 deletions
diff --git a/doc/doxygen.main b/doc/doxygen.main
new file mode 100644
index 00000000000..936bc9134a2
--- /dev/null
+++ b/doc/doxygen.main
@@ -0,0 +1,52 @@
+/** \mainpage Blender
+ *
+ * \section intro Introduction
+ *
+ * Blender is an integrated 3d package, which features:
+ * - modeling
+ * - animation
+ * - texturing
+ * - compositing
+ * - rendering
+ * - scripting
+ * - game creation
+ *
+ * These pages document the source code of blender.
+ *
+ * \section sects Main sections of the blender code
+ *
+ * The following sections are the broad categories into which the various modules
+ * belong.
+ *
+ * - \ref mainmodule
+ * - \ref render
+ * - \ref meshedit
+ * - \ref texture
+ * - \ref compositor
+ * - \ref scripts
+ * - \ref gameengine
+ *
+ * \section GUI
+ * - \ref gui
+ * - \ref hotkeys
+ * - \ref toolbox
+ *
+ * \section Miscellaneous
+ * - \ref undoc
+ */
+
+/** \defgroup mainmodule Main Module */
+/** \defgroup render Rendering Module */
+/** \defgroup meshedit Mesh Editing Module */
+/** \defgroup texture Textureing */
+/** \defgroup compositor Compositing */
+/** \defgroup scripts Scripting */
+/** \defgroup gameengine Game Engine */
+/** \defgroup gui GUI */
+/** \defgroup hotkeys Hotkeys
+ * \ingroup gui
+ */
+/** \defgroup toolbox Toolbox
+ * \ingroup gui
+ */
+/** \defgroup undoc Undocumented */