diff --git a/doc/Doxyfile b/doc/Doxyfile index e2928537fe7578b0e76800bfefa69911cd602cdf..27894c55bc23aeab81465c4d6c17118de0c030c7 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -632,15 +632,7 @@ INPUT = doxygen.main \ ../source/blender/gpu \ ../source/blender/avi \ ../intern/guardedalloc \ - ../source/gameengine/BlenderRoutines \ - ../source/gameengine/Converter \ - ../source/gameengine/Expressions \ - ../source/gameengine/GameLogic \ - ../source/gameengine/GamePlayer \ - ../source/gameengine/Ketsji \ - ../source/gameengine/Rasterizer \ - ../source/gameengine/Network \ - ../source/gameengine/Physics \ + ../source/gameengine \ ../extern/bullet2 # This tag can be used to specify the character encoding of the source files @@ -671,7 +663,7 @@ RECURSIVE = YES # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. -EXCLUDE = +EXCLUDE = ../source/gameengine/PyDoc # The EXCLUDE_SYMLINKS tag can be used select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/doc/doxygen.main b/doc/doxygen.main index 7f03753d82daa47376608ab077766bf8535ccce1..687bb2215d0dd1ab905a91aed5d4fa12c15245e7 100644 --- a/doc/doxygen.main +++ b/doc/doxygen.main @@ -42,6 +42,7 @@ /** \defgroup bullet Bullet Physics Library * \ingroup extern + * \see \ref bulletdoc */ /** \defgroup blenderplayer Blender Player */ @@ -104,6 +105,12 @@ /** \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 diff --git a/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h b/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h index 2dbd384e3734f034735ffc013ba7210380ab8aeb..4b97dc951791d3f78fbf1fb7e42d1806532e9398 100644 --- a/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h +++ b/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h @@ -15,6 +15,7 @@ subject to the following restrictions: /** \file CcdPhysicsEnvironment.h * \ingroup physbullet + * See also \ref bulletdoc */ #ifndef CCDPHYSICSENVIRONMENT diff --git a/source/gameengine/SceneGraph/SG_BBox.h b/source/gameengine/SceneGraph/SG_BBox.h index 1a65fc7ef6f0afd558e2ad4e46411aec2cb9ddb3..9b18c121919c8c482866166b73fa1691080e6cec 100644 --- a/source/gameengine/SceneGraph/SG_BBox.h +++ b/source/gameengine/SceneGraph/SG_BBox.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,11 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Bounding Box + */ + +/** \file SG_BBox.h + * \ingroup bgesg + * \brief Bounding Box */ #ifndef __SG_BBOX_H__ diff --git a/source/gameengine/SceneGraph/SG_Controller.h b/source/gameengine/SceneGraph/SG_Controller.h index b4636d5fa62877fe9eb4a6c373b4a7a8cc03ba78..fbc27bb93f308964e3ce0f0366ff781b31358c06 100644 --- a/source/gameengine/SceneGraph/SG_Controller.h +++ b/source/gameengine/SceneGraph/SG_Controller.h @@ -1,4 +1,4 @@ -/** +/* * Implementationclass to derive controllers from * * $Id$ @@ -29,6 +29,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SG_Controller.h + * \ingroup bgesg + */ + #ifndef __SG_CONTROLLER_H #define __SG_CONTROLLER_H diff --git a/source/gameengine/SceneGraph/SG_DList.h b/source/gameengine/SceneGraph/SG_DList.h index 0768eaa50219e1051ecb46bc5bd57009aae6b0dc..b82e51e0d2f8b411714cbfc11768d349146cfdb6 100644 --- a/source/gameengine/SceneGraph/SG_DList.h +++ b/source/gameengine/SceneGraph/SG_DList.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_DList.h + * \ingroup bgesg + */ + #ifndef __SG_DLIST #define __SG_DLIST diff --git a/source/gameengine/SceneGraph/SG_IObject.h b/source/gameengine/SceneGraph/SG_IObject.h index 4c9c31e49342b3d3686c12a3ff0b5cd6a28419e1..26e317bdcd98417cef7649eb564d8f6df83e8652 100644 --- a/source/gameengine/SceneGraph/SG_IObject.h +++ b/source/gameengine/SceneGraph/SG_IObject.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_IObject.h + * \ingroup bgesg + */ + #ifndef __SG_IOBJECT #define __SG_IOBJECT diff --git a/source/gameengine/SceneGraph/SG_Node.h b/source/gameengine/SceneGraph/SG_Node.h index 30d09b5bdfd0d29d4c1b283b9a90ab5ff36e587e..1116cc53672deb56937397872f62bf0f4e4f37d2 100644 --- a/source/gameengine/SceneGraph/SG_Node.h +++ b/source/gameengine/SceneGraph/SG_Node.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_Node.h + * \ingroup bgesg + */ + #ifndef __SG_NODE_H #define __SG_NODE_H diff --git a/source/gameengine/SceneGraph/SG_ParentRelation.h b/source/gameengine/SceneGraph/SG_ParentRelation.h index 0bc04245c93eb51b64d5a630e0db72fdd2244106..52e418031858039d21ee60e0a4d2ad73bfd4b439 100644 --- a/source/gameengine/SceneGraph/SG_ParentRelation.h +++ b/source/gameengine/SceneGraph/SG_ParentRelation.h @@ -1,23 +1,4 @@ -/** - * @mainpage SG_ParentRelation - - * @section - * - * This is an abstract interface class to the Scene Graph library. - * It allows you to specify how child nodes react to parent nodes. - * Normally a child will use it's parent's transforms to compute - * it's own global transforms. How this is performed depends on - * the type of relation. For example if the parent is a vertex - * parent to this child then the child should not inherit any - * rotation information from the parent. Or if the parent is a - * 'slow parent' to this child then the child should react - * slowly to changes in the parent's position. The exact relation - * is left for you to implement by filling out this interface - * with concrete examples. - * - * There is exactly one SG_ParentRelation per SG_Node. Subclasses - * should not be value types and should be allocated on the heap. - * +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -47,6 +28,29 @@ * */ +/** \file SG_ParentRelation.h + * \ingroup bgesg + * @page SG_ParentRelationPage SG_ParentRelation + + * @section + * + * This is an abstract interface class to the Scene Graph library. + * It allows you to specify how child nodes react to parent nodes. + * Normally a child will use it's parent's transforms to compute + * it's own global transforms. How this is performed depends on + * the type of relation. For example if the parent is a vertex + * parent to this child then the child should not inherit any + * rotation information from the parent. Or if the parent is a + * 'slow parent' to this child then the child should react + * slowly to changes in the parent's position. The exact relation + * is left for you to implement by filling out this interface + * with concrete examples. + * + * There is exactly one SG_ParentRelation per SG_Node. Subclasses + * should not be value types and should be allocated on the heap. + * + */ + #ifndef __SG_ParentRelation_h #define __SG_ParentRelation_h diff --git a/source/gameengine/SceneGraph/SG_QList.h b/source/gameengine/SceneGraph/SG_QList.h index 691ec9e126258829993359fd2b01abbd2804de62..de79c35821e9a365d8d3f1183fe930a5401d6e13 100644 --- a/source/gameengine/SceneGraph/SG_QList.h +++ b/source/gameengine/SceneGraph/SG_QList.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -26,6 +26,11 @@ * * ***** END GPL LICENSE BLOCK ***** */ + +/** \file SG_QList.h + * \ingroup bgesg + */ + #ifndef __SG_QLIST #define __SG_QLIST diff --git a/source/gameengine/SceneGraph/SG_Spatial.h b/source/gameengine/SceneGraph/SG_Spatial.h index b8193806ecb8f9ae23ce3d14190b9f464b760b24..e15a3f3cc3276a10f365ca02a660106f56cb5120 100644 --- a/source/gameengine/SceneGraph/SG_Spatial.h +++ b/source/gameengine/SceneGraph/SG_Spatial.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -27,6 +27,10 @@ * ***** END GPL LICENSE BLOCK ***** */ +/** \file SG_Spatial.h + * \ingroup bgesg + */ + #ifndef __SG_SPATIAL_H #define __SG_SPATIAL_H diff --git a/source/gameengine/SceneGraph/SG_Tree.h b/source/gameengine/SceneGraph/SG_Tree.h index fa6facde66ce8067c857b756a1e7d019fc8c7eed..4ab8586f09f8d4a3baa3735a51973ca0fdafedc6 100644 --- a/source/gameengine/SceneGraph/SG_Tree.h +++ b/source/gameengine/SceneGraph/SG_Tree.h @@ -1,4 +1,4 @@ -/** +/* * $Id$ * * ***** BEGIN GPL LICENSE BLOCK ***** @@ -25,7 +25,10 @@ * Contributor(s): none yet. * * ***** END GPL LICENSE BLOCK ***** - * Bounding Box + */ + +/** \file SG_Tree.h + * \ingroup bgesg */ #ifndef __SG_TREE_H__ diff --git a/source/gameengine/VideoTexture/BlendType.h b/source/gameengine/VideoTexture/BlendType.h index 2b273253af60606d5858a3f71fa2b37c20cd4309..a5c695d737e0db9ada0e42778f592d7639c0c79e 100644 --- a/source/gameengine/VideoTexture/BlendType.h +++ b/source/gameengine/VideoTexture/BlendType.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file BlendType.h + * \ingroup bgevideotex + */ + #if !defined BLENDTYPE_H #define BLENDTYPE_H diff --git a/source/gameengine/VideoTexture/Common.h b/source/gameengine/VideoTexture/Common.h index f771077bbba3477e4c81ed1da9579d2c48ac60aa..85c81e33e2e55ec468f53984c221e8ad61e16679 100644 --- a/source/gameengine/VideoTexture/Common.h +++ b/source/gameengine/VideoTexture/Common.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file Common.h + * \ingroup bgevideotex + */ + #if defined WIN32 #define WINDOWS_LEAN_AND_MEAN #endif diff --git a/source/gameengine/VideoTexture/Exception.h b/source/gameengine/VideoTexture/Exception.h index 74dc444c0a99337a9ffcfa8205ae7b346d623cf9..16248186108186579ae1db65a7cfb771c6ed529f 100644 --- a/source/gameengine/VideoTexture/Exception.h +++ b/source/gameengine/VideoTexture/Exception.h @@ -21,6 +21,10 @@ http://www.gnu.org/copyleft/lesser.txt. */ +/** \file Exception.h + * \ingroup bgevideotex + */ + #if !defined EXCEPTION_H #define EXCEPTION_H diff --git a/source/gameengine/VideoTexture/FilterBase.h b/source/gameengine/VideoTexture/FilterBase.h index b6080f018d5108bea234d9dcee36c58aea353d55..5bba153be2ac613e20eadc63742910d61b6e7f20 100644 --- a/source/gameengine/VideoTexture/FilterBase.h +++ b/source/gameengine/VideoTexture/FilterBase.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file FilterBase.h + * \ingroup bgevideotex + */ + #if !defined FILTERBASE_H #define FILTERBASE_H diff --git a/source/gameengine/VideoTexture/FilterBlueScreen.h b/source/gameengine/VideoTexture/FilterBlueScreen.h index 78728d291d84875a098ccbed34a6c73e64ce9b8e..0aa3022299de062e9c3afaae2baa3a1a12417ffb 100644 --- a/source/gameengine/VideoTexture/FilterBlueScreen.h +++ b/source/gameengine/VideoTexture/FilterBlueScreen.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file FilterBlueScreen.h + * \ingroup bgevideotex + */ + #if !defined FILTERBLUESCREEN_H #define FILTERBLUESCREEN_H diff --git a/source/gameengine/VideoTexture/FilterColor.h b/source/gameengine/VideoTexture/FilterColor.h index b7e52c4521c3c6f954a4fb17dd810cb7304d53d5..2478727a6be350a6d2e0b43937d8fc31d4a4959c 100644 --- a/source/gameengine/VideoTexture/FilterColor.h +++ b/source/gameengine/VideoTexture/FilterColor.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file FilterColor.h + * \ingroup bgevideotex + */ + #if !defined FILTERCOLOR_H #define FILTERCOLOR_H diff --git a/source/gameengine/VideoTexture/FilterNormal.h b/source/gameengine/VideoTexture/FilterNormal.h index 840043be9a133c02eb99b045f814049a3776aa83..90ebd6c03ed35d7130cf0f5a75a739b29c2faccd 100644 --- a/source/gameengine/VideoTexture/FilterNormal.h +++ b/source/gameengine/VideoTexture/FilterNormal.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file FilterNormal.h + * \ingroup bgevideotex + */ + #if !defined FILTERNORMAL_H #define FILTERNORMAL_H diff --git a/source/gameengine/VideoTexture/FilterSource.h b/source/gameengine/VideoTexture/FilterSource.h index 254e0a026792c0fb0335625803bbb97c2e46e29f..3518f3134fff157577cbf3748910e27b210c29f3 100644 --- a/source/gameengine/VideoTexture/FilterSource.h +++ b/source/gameengine/VideoTexture/FilterSource.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file FilterSource.h + * \ingroup bgevideotex + */ + #if !defined FILTERSOURCE_H #define FILTERSOURCE_H diff --git a/source/gameengine/VideoTexture/ImageBase.h b/source/gameengine/VideoTexture/ImageBase.h index 43a56290beeb6002632166000d68c2f6c4407042..53485ceef7ac3484497ae7896ddf8e1b93cccc77 100644 --- a/source/gameengine/VideoTexture/ImageBase.h +++ b/source/gameengine/VideoTexture/ImageBase.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file ImageBase.h + * \ingroup bgevideotex + */ + #if !defined IMAGEBASE_H #define IMAGEBASE_H diff --git a/source/gameengine/VideoTexture/ImageBuff.h b/source/gameengine/VideoTexture/ImageBuff.h index 271647361e87a67332e6660f22e40907ef7b6c99..f0f14f2b4b103868576894cadc91ed4153f467bc 100644 --- a/source/gameengine/VideoTexture/ImageBuff.h +++ b/source/gameengine/VideoTexture/ImageBuff.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file ImageBuff.h + * \ingroup bgevideotex + */ + #if !defined IMAGEBUFF_H #define IMAGEBUFF_H diff --git a/source/gameengine/VideoTexture/ImageMix.h b/source/gameengine/VideoTexture/ImageMix.h index 47bd644860fc7587ebd45579893d016adc82ccc5..ada936b4be552865de21de0f86b242d98478741f 100644 --- a/source/gameengine/VideoTexture/ImageMix.h +++ b/source/gameengine/VideoTexture/ImageMix.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file ImageMix.h + * \ingroup bgevideotex + */ + #if !defined IMAGEMIX_H #define IMAGEMIX_H diff --git a/source/gameengine/VideoTexture/ImageRender.h b/source/gameengine/VideoTexture/ImageRender.h index 7861a2df79a8c49ffb490deee992a647784988bb..1101fbbc2d4aadba4d5c2fe13026adcefeb54287 100644 --- a/source/gameengine/VideoTexture/ImageRender.h +++ b/source/gameengine/VideoTexture/ImageRender.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file ImageRender.h + * \ingroup bgevideotex + */ + #if !defined IMAGERENDER_H #define IMAGERENDER_H diff --git a/source/gameengine/VideoTexture/ImageViewport.h b/source/gameengine/VideoTexture/ImageViewport.h index 49db56bcf19beb213936c467f7e96e9d0387dc50..1b415fc58be33bbd53da373baa0765559d8eb7ed 100644 --- a/source/gameengine/VideoTexture/ImageViewport.h +++ b/source/gameengine/VideoTexture/ImageViewport.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file ImageViewport.h + * \ingroup bgevideotex + */ + #if !defined IMAGEVIEWPORT_H #define IMAGEVIEWPORT_H diff --git a/source/gameengine/VideoTexture/PyTypeList.h b/source/gameengine/VideoTexture/PyTypeList.h index 8ca1e976de75c2e93b372df6d585b319e6f19b92..089699aaa7eca4af69a1b25739ba9b4c9aca68ee 100644 --- a/source/gameengine/VideoTexture/PyTypeList.h +++ b/source/gameengine/VideoTexture/PyTypeList.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file PyTypeList.h + * \ingroup bgevideotex + */ + #if !defined PYTYPELIST_H #define PYTYPELIST_H diff --git a/source/gameengine/VideoTexture/Texture.h b/source/gameengine/VideoTexture/Texture.h index 1bbef8f0f9e323d87a264ded69978ee775798e32..d2b3b49eaf58a2e0edd9862d1e74d60d2b8b23d4 100644 --- a/source/gameengine/VideoTexture/Texture.h +++ b/source/gameengine/VideoTexture/Texture.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file Texture.h + * \ingroup bgevideotex + */ + #if !defined TEXTURE_H #define TEXTURE_H diff --git a/source/gameengine/VideoTexture/VideoBase.h b/source/gameengine/VideoTexture/VideoBase.h index 0c8668ee0bc130d83874a26f68c572e6d173858d..08000161f14f568cc0ef280bbb8e87f32e333cff 100644 --- a/source/gameengine/VideoTexture/VideoBase.h +++ b/source/gameengine/VideoTexture/VideoBase.h @@ -20,6 +20,10 @@ http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ +/** \file VideoBase.h + * \ingroup bgevideotex + */ + #if !defined VIDEOBASE_H #define VIDEOBASE_H diff --git a/source/gameengine/VideoTexture/VideoFFmpeg.h b/source/gameengine/VideoTexture/VideoFFmpeg.h index a19d8969b409f864f9ab7a9acd5b20848b5cffc2..9b09c485329a6b3a80173138304a46ef91630a31 100644 --- a/source/gameengine/VideoTexture/VideoFFmpeg.h +++ b/source/gameengine/VideoTexture/VideoFFmpeg.h @@ -19,6 +19,11 @@ Place - Suite 330, Boston, MA 02111-1307, USA, or go to http://www.gnu.org/copyleft/lesser.txt. ----------------------------------------------------------------------------- */ + +/** \file VideoFFmpeg.h + * \ingroup bgevideotex + */ + #if !defined VIDEOFFMPEG_H #define VIDEOFFMPEG_H