blender/doc/doxygen.main
2011-02-22 19:30:37 +00:00

188 lines
4.0 KiB
Plaintext

/** \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 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. */