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
path: root/doc
diff options
context:
space:
mode:
authorNathan Letwory <nathan@letworyinteractive.com>2011-02-25 13:34:04 +0300
committerNathan Letwory <nathan@letworyinteractive.com>2011-02-25 13:34:04 +0300
commit83d6e06af5316b23806c2f6961035f2757e02773 (patch)
tree629650609535be44f4f595d2826dfe5f871c8cf6 /doc
parentbd610e942abe45a8724409836553d4721b343863 (diff)
doxygen: update Doxyfile and split doxygen.main
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile33
-rw-r--r--doc/doxygen.extern17
-rw-r--r--doc/doxygen.intern98
-rw-r--r--doc/doxygen.main168
-rw-r--r--doc/doxygen.source137
5 files changed, 261 insertions, 192 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 27894c55bc2..a29abac1373 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -613,26 +613,11 @@ WARN_LOGFILE =
# with spaces.
INPUT = doxygen.main \
- ../intern/mikktspace \
- ../source/blender/imbuf \
- ../source/blender/blenkernel \
- ../source/blender/collada \
- ../source/blender/editors \
- ../source/blender/windowmanager \
- ../source/blender/makesdna \
- ../source/blender/makesrna \
- ../intern/ghost \
- ../source/blender/blenloader \
- ../source/blender/readblenfile \
- ../source/blender/blenkernel \
- ../source/blender/blenlib \
- ../source/blender/render \
- ../source/blender/nodes \
- ../source/blender/modifiers \
- ../source/blender/gpu \
- ../source/blender/avi \
- ../intern/guardedalloc \
- ../source/gameengine \
+ doxygen.source \
+ doxygen.intern \
+ doxygen.extern \
+ ../source \
+ ../intern \
../extern/bullet2
# This tag can be used to specify the character encoding of the source files
@@ -889,7 +874,7 @@ HTML_COLORSTYLE_SAT = 100
# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2,
# and 100 does not change the gamma.
-HTML_COLORSTYLE_GAMMA = 80
+HTML_COLORSTYLE_GAMMA = 79
# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML
# page will contain the date and time when the page was generated. Setting
@@ -960,14 +945,14 @@ GENERATE_HTMLHELP = YES
# can add a path in front of the file if the result should not be
# written to the html output directory.
-CHM_FILE =
+CHM_FILE = blender.chm
# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can
# be used to specify the location (absolute path including file name) of
# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run
# the HTML help compiler on the generated index.hhp.
-HHC_LOCATION =
+HHC_LOCATION = "C:/Program Files (x86)/HTML Help Workshop/hhc.exe"
# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag
# controls if a separate .chi index file is generated (YES) or that
@@ -1094,7 +1079,7 @@ USE_INLINE_TREES = NO
# used to set the initial width (in pixels) of the frame in which the tree
# is shown.
-TREEVIEW_WIDTH = 250
+TREEVIEW_WIDTH = 246
# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open
# links to external symbols imported via tag files in a separate window.
diff --git a/doc/doxygen.extern b/doc/doxygen.extern
new file mode 100644
index 00000000000..6c6872ff53f
--- /dev/null
+++ b/doc/doxygen.extern
@@ -0,0 +1,17 @@
+/** \defgroup extern External libraries
+ * \section externabout External libraries
+ * As with \ref intern these libraries are
+ * provided in the Blender codebase. This is
+ * to make building Blender easier. The main
+ * development of these libraries is \b not part
+ * of the normal Blender development process, but
+ * each of the library is developed separately.
+ * Whenever deemed necessary libraries in \c extern/
+ * folder are updated.
+ *
+ */
+
+/** \defgroup bullet Bullet Physics Library
+ * \ingroup extern
+ * \see \ref bulletdoc
+ */
diff --git a/doc/doxygen.intern b/doc/doxygen.intern
new file mode 100644
index 00000000000..8f76c7004b8
--- /dev/null
+++ b/doc/doxygen.intern
@@ -0,0 +1,98 @@
+/** \defgroup intern Internal libraries
+ * \section internabout Internal libraries
+ * Blender comes with some of its dependencies
+ * directly included in the codebase. Libraries
+ * that are in the \c intern/ folder are maintained
+ * as part of the normal development process.
+ */
+
+/** \defgroup MEM Guarded memory (de)allocation
+ * \ingroup intern
+ */
+
+/** \defgroup boolop boolop
+ * \ingroup intern
+ */
+
+/** \defgroup ctr container
+ * \ingroup intern
+ */
+
+/** \defgroup decimation decimation
+ * \ingroup intern
+ */
+
+/** \defgroup elbeem elbeem
+ * \ingroup intern
+ */
+
+/** \defgroup iksolver iksolver
+ * \ingroup intern
+ */
+
+/** \defgroup itasc itasc
+ * \ingroup intern
+ */
+
+/** \defgroup memutil memutil
+ * \ingroup intern
+ */
+
+/** \defgroup mikktspace mikktspace
+ * \ingroup intern
+ */
+
+/** \defgroup moto moto
+ * \ingroup intern
+ */
+
+/** \defgroup opennl opennl
+ * \ingroup intern
+ */
+
+/** \defgroup smoke smoke
+ * \ingroup intern
+ */
+
+/** \defgroup string string
+ * \ingroup intern
+ */
+
+/** \defgroup audaspace Audaspace
+ * \ingroup intern undoc
+ * \todo add to doxygen
+ */
+/** \defgroup audfx Audaspace FX
+ * \ingroup audaspace
+ */
+/** \defgroup audopenal Audaspace OpenAL
+ * \ingroup audaspace
+ */
+/** \defgroup audpython Audaspace Python
+ * \ingroup audaspace
+ */
+/** \defgroup audsdl Audaspace SDL
+ * \ingroup audaspace
+ */
+/** \defgroup audsrc Audaspace SRC
+
+ * \ingroup audaspace
+ */
+/** \defgroup audffmpeg Audaspace FFMpeg
+ * \ingroup audaspace
+ */
+/** \defgroup audfftw Audaspace FFTW
+ * \ingroup audaspace
+ */
+/** \defgroup audjack Audaspace Jack
+ * \ingroup audaspace
+ */
+/** \defgroup audsndfile Audaspace sndfile
+ * \ingroup audaspace
+ */
+
+/** \defgroup GHOST GHOST API
+ * \ingroup intern GUI
+ * \ref GHOSTPage
+ */
+
diff --git a/doc/doxygen.main b/doc/doxygen.main
index 687bb2215d0..188382d6a9c 100644
--- a/doc/doxygen.main
+++ b/doc/doxygen.main
@@ -15,173 +15,5 @@
*
*/
-/** \defgroup intern Internal libraries
- * \section internabout Internal libraries
- * Blender comes with some of its dependencies
- * directly included in the codebase. Libraries
- * that are in the \c intern/ folder are maintained
- * as part of the normal development process.
- */
-
-/** \defgroup MEM Guarded memory (de)allocation
- * \ingroup intern
- */
-
-/** \defgroup extern External libraries
- * \section externabout External libraries
- * As with \ref intern these libraries are
- * provided in the Blender codebase. This is
- * to make building Blender easier. The main
- * development of these libraries is \b not part
- * of the normal Blender development process, but
- * each of the library is developed separately.
- * Whenever deemed necessary libraries in \c extern/
- * folder are updated.
- *
- */
-
-/** \defgroup bullet Bullet Physics Library
- * \ingroup extern
- * \see \ref bulletdoc
- */
-
-/** \defgroup blenderplayer Blender Player */
-
-/** \defgroup render Rendering */
-/** \defgroup meshedit Mesh Editing */
-/** \defgroup texture Texturing */
-/** \defgroup compositor Compositing */
-
-/** \defgroup scripts Scripting */
-
-/** \defgroup python Python
- * \ingroup scripts
- */
-
-/** \defgroup bge Game Engine */
-/** \defgroup gamelogic Game Logic
- * \ingroup bge
- */
-/** \defgroup bgeconv Converter
- * \ingroup bge
- */
-/** \defgroup blroutines Blender Routines
- * \ingroup bge
- */
-/** \defgroup expressions Expressions
- * \ingroup bge
- */
-/** \defgroup player Game Player
- * \ingroup bge
- */
-/** \defgroup ketsji Ketsji
- * \ingroup bge
- * \todo check all headers and code files for proper licenses
- */
-/** \defgroup ketsjinet Ketsji Network
- * \ingroup ketsji
- */
-/** \defgroup bgenet Network
- * \ingroup bge
- */
-/** \defgroup bgenetlb Loopback Network
- * \ingroup bgenet
- */
-/** \defgroup phys Physics
- * \ingroup bge
- */
-/** \defgroup physbullet Bullet Physics
- * \ingroup phys
- */
-/** \defgroup physdummy Dummy Physics (none)
- * \ingroup phys
- */
-/** \defgroup bgerast Rasterizer
- * \ingroup bge
- */
-/** \defgroup bgerastoglfilters OpenGL Filters
- * \ingroup bgerast
- */
-/** \defgroup bgerastogl OpenGL Rasterizer
- * \ingroup bgerast
- */
-/** \defgroup bgesg BGE SceneGraph
- * \ingroup bge
- */
-/** \defgroup bgevideotex BGE Video Texture
- * \ingroup bge
- */
-
-/** \defgroup audaspace Audaspace
- * \ingroup intern undoc
- * \todo add to doxygen
- */
-
-/** \defgroup core core */
-
-/** \defgroup bke blenkernel
- * \ingroup core
- */
-
-/** \defgroup bli blenlib
- * \ingroup core
- */
-
-/** \defgroup nodes nodes
- * \ingroup core
- */
-
-/** \defgroup modifiers modifiers
- * \ingroup core
- */
-
-/** \defgroup data DNA, RNA and .blend access*/
-
-/** \defgroup GHOST GHOST API
- * \ingroup intern GUI
- * \ref GHOSTPage
- */
-
-/** \defgroup gpu GPU */
-
-/** \defgroup DNA sDNA
- * \ingroup data
- */
-/** \defgroup RNA RNA
- * \ingroup data
- */
-
-/** \defgroup readwrite .blend read and write functions
- * \ingroup data
- */
-
-/** \defgroup readblenfile readblenfile
- * \ingroup data
- */
-
-/** \defgroup gui GUI */
-
-/** \defgroup wm windowmanager
- * \ingroup gui
- */
-
-/** \defgroup editors Editors */
-
-/** \defgroup editorui Interface and Widgets
- * \ingroup gui
- */
-
-/** \defgroup externformats external formats */
-
-/** \defgroup collada COLLADA
- * \ingroup externformats
- */
-
-/** \defgroup avi AVI
- * \ingroup externformats
- */
-
-/** \defgroup imbuf IMage Buffer */
-
/** \defgroup undoc Undocumented
* \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */
diff --git a/doc/doxygen.source b/doc/doxygen.source
new file mode 100644
index 00000000000..a398826c567
--- /dev/null
+++ b/doc/doxygen.source
@@ -0,0 +1,137 @@
+
+/** \defgroup blenderplayer Blender Player */
+
+/** \defgroup render Rendering */
+/** \defgroup meshedit Mesh Editing */
+/** \defgroup texture Texturing */
+/** \defgroup compositor Compositing */
+
+/** \defgroup scripts Scripting */
+
+/** \defgroup python Python
+ * \ingroup scripts
+ */
+
+/* ================================ */
+
+/** \defgroup bge Game Engine */
+/** \defgroup gamelogic Game Logic
+ * \ingroup bge
+ */
+/** \defgroup bgeconv Converter
+ * \ingroup bge
+ */
+/** \defgroup blroutines Blender Routines
+ * \ingroup bge
+ */
+/** \defgroup expressions Expressions
+ * \ingroup bge
+ */
+/** \defgroup player Game Player
+ * \ingroup bge
+ */
+/** \defgroup ketsji Ketsji
+ * \ingroup bge
+ * \todo check all headers and code files for proper licenses
+ */
+/** \defgroup ketsjinet Ketsji Network
+ * \ingroup ketsji
+ */
+/** \defgroup bgenet Network
+ * \ingroup bge
+ */
+/** \defgroup bgenetlb Loopback Network
+ * \ingroup bgenet
+ */
+/** \defgroup phys Physics
+ * \ingroup bge
+ */
+/** \defgroup physbullet Bullet Physics
+ * \ingroup phys
+ */
+/** \defgroup physdummy Dummy Physics (none)
+ * \ingroup phys
+ */
+/** \defgroup bgerast Rasterizer
+ * \ingroup bge
+ */
+/** \defgroup bgerastoglfilters OpenGL Filters
+ * \ingroup bgerast
+ */
+/** \defgroup bgerastogl OpenGL Rasterizer
+ * \ingroup bgerast
+ */
+/** \defgroup bgesg BGE SceneGraph
+ * \ingroup bge
+ */
+/** \defgroup bgevideotex BGE Video Texture
+ * \ingroup bge
+ */
+
+/* ================================ */
+
+/** \defgroup blender blender */
+
+/** \defgroup bke blenkernel
+ * \ingroup blender
+ */
+
+/** \defgroup bli blenlib
+ * \ingroup blender
+ */
+
+/** \defgroup nodes nodes
+ * \ingroup blender
+ */
+
+/** \defgroup modifiers modifiers
+ * \ingroup blender
+ */
+
+/** \defgroup data DNA, RNA and .blend access*/
+
+/** \defgroup gpu GPU */
+
+/** \defgroup DNA sDNA
+ * \ingroup data
+ */
+/** \defgroup RNA RNA
+ * \ingroup data
+ */
+
+/** \defgroup readwrite .blend read and write functions
+ * \ingroup data
+ */
+
+/** \defgroup readblenfile readblenfile
+ * \ingroup data
+ */
+
+/** \defgroup gui GUI */
+
+/** \defgroup wm windowmanager
+ * \ingroup gui
+ */
+
+/** \defgroup editors Editors
+ * \ingroup blender
+ */
+
+/** \defgroup editorui Interface and Widgets
+ * \ingroup gui
+ */
+
+/** \defgroup externformats external formats */
+
+/** \defgroup collada COLLADA
+ * \ingroup externformats
+ */
+
+/** \defgroup avi AVI
+ * \ingroup externformats
+ */
+
+/** \defgroup imbuf IMage Buffer */
+
+/** \defgroup undoc Undocumented
+ * \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */