doxygen: bge scenegraph and videotexture

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 

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

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

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__

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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__

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
 

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

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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
 

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