kannonier8/blender
1
0
Fork 0
forked from bartvdbraak/blender
Code Pull Requests Activity
ff84ad3151
blender/doc/doxygen.main

114 lines
2.6 KiB
Plaintext
Raw Normal View History

This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
/** \mainpage Blender
*
* \section intro Introduction
*
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
* Blender is an integrated 3d package.
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
*
* These pages document the source code of blender.
*
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
* For more information on using Blender browse to http://www.blender.org
*
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
* \section sects Main sections of the blender code
*
* The following sections are the broad categories into which the various modules
* belong.
*
* - \ref render
* - \ref meshedit
* - \ref texture
* - \ref compositor
* - \ref scripts
* - \ref gameengine
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
* - \ref data
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
*
* \section GUI
* - \ref gui
*
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
* \section libraries Libraries and Wrappers
* - \ref GHOST
Added ghost and imbuf to mainpage.
2003-05-24 20:48:29 +00:00
* - \ref imbuf
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
* - \ref audaspace
* - \ref DNA
* - \ref RNA
Added ghost and imbuf to mainpage.
2003-05-24 20:48:29 +00:00
*
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
* \section Miscellaneous
* - \ref undoc
*/
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
/** \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 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.
*
Added group defaultconfig to group mainmodule.
2003-05-24 00:41:27 +00:00
*/
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
/** \defgroup editors Editor modules */
/** \defgroup blenderplayer Blender Player */
Added group defaultconfig to group mainmodule.
2003-05-24 00:41:27 +00:00
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
/** \defgroup render Rendering Module */
/** \defgroup meshedit Mesh Editing Module */
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
/** \defgroup texture Texturing */
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
/** \defgroup compositor Compositing */
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
/** \defgroup scripts Scripting */
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
/** \defgroup gameengine Game Engine */
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
/** \defgroup audaspace Audaspace
* \ingroup intern undoc
* \todo add to doxygen
*/
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
doxygen: blenkernel under core as module.
2011-02-18 13:05:18 +00:00
/** \defgroup core core */
/** \defgroup bke blenkernel
* \ingroup core
*/
/** \defgroup bli blenlib
* \ingroup core
*/
Bring blenloader module under data group. Rename the group to look a bit more sensible in the output.
2011-02-17 23:34:07 +00:00
/** \defgroup data DNA, RNA and .blend access*/
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
/** \defgroup GHOST GHOST API */
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
/** \defgroup DNA sDNA
* \ingroup data
*/
/** \defgroup RNA RNA
* \ingroup data
*/
Added group defaultconfig to group mainmodule.
2003-05-24 00:41:27 +00:00
Bring blenloader module under data group. Rename the group to look a bit more sensible in the output.
2011-02-17 23:34:07 +00:00
/** \defgroup readwrite .blend read and write functions
* \ingroup data
*/
doxygen: readblenfile part of data group
2011-02-18 10:35:37 +00:00
/** \defgroup readblenfile readblenfile
* \ingroup data
*/
This is the initial commit for the doxygen config file and the file which defines the blender blender mainpage and the major module groups.
2003-05-24 00:10:39 +00:00
/** \defgroup gui GUI */
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
Starting work on doxygen cleanup. Many things still to be done.
2011-02-17 05:57:18 +00:00
/** \defgroup wm windowmanager
* \ingroup gui
*/
Added group defaultconfig to group mainmodule.
2003-05-24 00:41:27 +00:00
Added ghost and imbuf to mainpage.
2003-05-24 20:48:29 +00:00
/** \defgroup imbuf IMage Buffer */
Start simple intros for intern and extern libs. Some reorg of modules/pages, start makesdna and makesrna. In many places license block needs to be changed to not start with /**, because otherwise documentation will go weird.
2011-02-17 16:17:40 +00:00
/** \defgroup undoc Undocumented
* \brief Modules and libraries that are still undocumented, or lacking proper integration into the doxygen system, are marked in this group. */
Copy Permalink