move doxygen files into own subdir.
This commit is contained in:
Nathan Letwory
1694
doc/doxygen/Doxyfile
Normal file
1694
doc/doxygen/Doxyfile
Normal file
File diff suppressed because it is too large
Load Diff
17
doc/doxygen/doxygen.extern
Normal file
17
doc/doxygen/doxygen.extern
Normal file
@@ -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
|
||||
*/
|
||||
102
doc/doxygen/doxygen.intern
Normal file
102
doc/doxygen/doxygen.intern
Normal file
@@ -0,0 +1,102 @@
|
||||
/** \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 bsp bsp
|
||||
* \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
|
||||
*/
|
||||
|
||||
19
doc/doxygen/doxygen.main
Normal file
19
doc/doxygen/doxygen.main
Normal file
@@ -0,0 +1,19 @@
|
||||
/** \mainpage Blender
|
||||
*
|
||||
* \section intro Introduction
|
||||
*
|
||||
* Blender is an integrated 3d package.
|
||||
*
|
||||
* These pages document the source code of blender.
|
||||
*
|
||||
* \subsection implinks Important Links
|
||||
* - <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>
|
||||
* - <a href="http://wiki.blender.org/index.php/Dev:Contents">Development documents</a> on our wiki.
|
||||
*
|
||||
* \subsection blother Other
|
||||
* For more information on using Blender browse to http://www.blender.org
|
||||
*
|
||||
*/
|
||||
|
||||
/** \defgroup undoc Undocumented
|
||||
* \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */
|
||||
358
doc/doxygen/doxygen.source
Normal file
358
doc/doxygen/doxygen.source
Normal file
@@ -0,0 +1,358 @@
|
||||
|
||||
/** \defgroup blenderplayer Blender Player */
|
||||
|
||||
/** \defgroup blc bad level calls
|
||||
* \ingroup blenderplayer
|
||||
*/
|
||||
|
||||
/** \defgroup render Rendering
|
||||
* \ingroup blender
|
||||
*/
|
||||
/** \defgroup meshedit Mesh Editing */
|
||||
/** \defgroup texture Texturing */
|
||||
/** \defgroup compositor Compositing */
|
||||
|
||||
/** \defgroup scripts Scripting */
|
||||
|
||||
/** \defgroup python Python
|
||||
* \ingroup blender scripts
|
||||
*/
|
||||
|
||||
/** \defgroup pygen Python Generic
|
||||
* \ingroup python
|
||||
*/
|
||||
|
||||
/** \defgroup pythonintern Python RNA and Operators
|
||||
* \ingroup python
|
||||
*/
|
||||
|
||||
/** \defgroup blpluginapi Blender pluginapi
|
||||
* \ingroup blender
|
||||
* \attention not in use currently
|
||||
*/
|
||||
|
||||
/* ================================ */
|
||||
|
||||
/** \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 blf blenfont
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup bke blenkernel
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup bli blenlib
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup nodes nodes
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup cmpnodes cmpnodes
|
||||
* \ingroup nodes
|
||||
*/
|
||||
|
||||
/** \defgroup shdnodes shdnodes
|
||||
* \ingroup nodes
|
||||
*/
|
||||
|
||||
/** \defgroup texnodes texnodes
|
||||
* \ingroup nodes
|
||||
*/
|
||||
/** \defgroup modifiers modifiers
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup data DNA, RNA and .blend access*/
|
||||
|
||||
/** \defgroup gpu GPU
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup ikplugin ikplugin
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup DNA sDNA
|
||||
* \ingroup blender data
|
||||
*/
|
||||
/** \defgroup RNA RNA
|
||||
* \ingroup blender data
|
||||
*/
|
||||
|
||||
/** \defgroup blenloader .blend read and write functions
|
||||
* \ingroup blender data
|
||||
* \todo check if \ref blo and \ref blenloader groups can be
|
||||
* merged in docs.
|
||||
*/
|
||||
|
||||
/** \defgroup blo readblenfile
|
||||
* \ingroup blender data
|
||||
*/
|
||||
|
||||
/** \defgroup quicktime quicktime
|
||||
* \ingroup blender
|
||||
|
||||
/** \defgroup gui GUI */
|
||||
|
||||
/** \defgroup wm windowmanager
|
||||
* \ingroup blender gui
|
||||
*/
|
||||
|
||||
/* ================================ */
|
||||
|
||||
/** \defgroup editors Editors
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup edanimation animation
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edarmature armature
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edcurve curve
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup eddatafiles datafiles
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edgpencil gpencil
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edinterface interface
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edmesh mesh
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edmeta metaball
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edobj object
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edphys physics
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edrend render
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edscr screen
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edsculpt sculpt and paint
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edsnd sound
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spaction action space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spapi space API
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spbuttons buttons space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spconsole console space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spfile fileselector
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spgraph graph editor
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spimage image and UV editor
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spinfo info space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup splogic game logic editor
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spnla NLA editor
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spnode node editor
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spoutliner outliner space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spscript script space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spseq sequencer
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spsnd sound space
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup sptext text editor
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup sptime time line
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spuserpref user preferences
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spview3d 3D view
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edtransform transform
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup edutil editor utilities
|
||||
* \ingroup editors
|
||||
*/
|
||||
|
||||
/** \defgroup spuv UV editing
|
||||
* \ingroup 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
|
||||
* \ingroup blender
|
||||
*/
|
||||
|
||||
/** \defgroup imbcineon Cineon
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
/** \defgorup imbdds DDS
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
/** \defgroup openexr OpenEXR
|
||||
* \ingroup imbuf
|
||||
*/
|
||||
|
||||
/* ================================ */
|
||||
|
||||
/** \defgroup kernel kernel */
|
||||
|
||||
/** \defgroup genmess gen_messaging
|
||||
* \ingroup kernel
|
||||
*/
|
||||
|
||||
/** \defgroup gensys gen_system
|
||||
* \ingroup kernel
|
||||
*/
|
||||
|
||||
/* ================================ */
|
||||
|
||||
/** \defgroup undoc Undocumented
|
||||
* \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */
|
||||
5
doc/doxygen/footer.html
Normal file
5
doc/doxygen/footer.html
Normal file
@@ -0,0 +1,5 @@
|
||||
<hr class="footer"/><address class="footer"><small>Generated on $datetime for $projectname by 
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
doxygen</a> $doxygenversion </small></address>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user