From 1f4fc992ef7840931439c161514bff710c6e6dca Mon Sep 17 00:00:00 2001
From: Nathan Letwory <nathan@letworyinteractive.com>
Date: Tue, 22 Feb 2011 19:30:37 +0000
Subject: [PATCH] doxygen: bge scenegraph and videotexture
---
doc/Doxyfile | 12 +----
doc/doxygen.main | 7 +++
.../Physics/Bullet/CcdPhysicsEnvironment.h | 1 +
source/gameengine/SceneGraph/SG_BBox.h | 8 +++-
source/gameengine/SceneGraph/SG_Controller.h | 6 ++-
source/gameengine/SceneGraph/SG_DList.h | 7 ++-
source/gameengine/SceneGraph/SG_IObject.h | 7 ++-
source/gameengine/SceneGraph/SG_Node.h | 7 ++-
.../gameengine/SceneGraph/SG_ParentRelation.h | 44 ++++++++++---------
source/gameengine/SceneGraph/SG_QList.h | 7 ++-
source/gameengine/SceneGraph/SG_Spatial.h | 6 ++-
source/gameengine/SceneGraph/SG_Tree.h | 7 ++-
source/gameengine/VideoTexture/BlendType.h | 4 ++
source/gameengine/VideoTexture/Common.h | 4 ++
source/gameengine/VideoTexture/Exception.h | 4 ++
source/gameengine/VideoTexture/FilterBase.h | 4 ++
.../VideoTexture/FilterBlueScreen.h | 4 ++
source/gameengine/VideoTexture/FilterColor.h | 4 ++
source/gameengine/VideoTexture/FilterNormal.h | 4 ++
source/gameengine/VideoTexture/FilterSource.h | 4 ++
source/gameengine/VideoTexture/ImageBase.h | 4 ++
source/gameengine/VideoTexture/ImageBuff.h | 4 ++
source/gameengine/VideoTexture/ImageMix.h | 4 ++
source/gameengine/VideoTexture/ImageRender.h | 4 ++
.../gameengine/VideoTexture/ImageViewport.h | 4 ++
source/gameengine/VideoTexture/PyTypeList.h | 4 ++
source/gameengine/VideoTexture/Texture.h | 4 ++
source/gameengine/VideoTexture/VideoBase.h | 4 ++
source/gameengine/VideoTexture/VideoFFmpeg.h | 5 +++
29 files changed, 148 insertions(+), 40 deletions(-)
diff --git a/doc/Doxyfile b/doc/Doxyfile
index e2928537fe7..27894c55bc2 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 7f03753d82d..687bb2215d0 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 2dbd384e373..4b97dc95179 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 1a65fc7ef6f..9b18c121919 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 b4636d5fa62..fbc27bb93f3 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 0768eaa5021..b82e51e0d2f 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 4c9c31e4934..26e317bdcd9 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 30d09b5bdfd..1116cc53672 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 0bc04245c93..52e41803185 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 691ec9e1262..de79c35821e 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 b8193806ecb..e15a3f3cc32 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 fa6facde66c..4ab8586f09f 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 2b273253af6..a5c695d737e 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 f771077bbba..85c81e33e2e 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 74dc444c0a9..16248186108 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 b6080f018d5..5bba153be2a 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 78728d291d8..0aa3022299d 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 b7e52c4521c..2478727a6be 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 840043be9a1..90ebd6c03ed 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 254e0a02679..3518f3134ff 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 43a56290bee..53485ceef7a 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 271647361e8..f0f14f2b4b1 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 47bd644860f..ada936b4be5 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 7861a2df79a..1101fbbc2d4 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 49db56bcf19..1b415fc58be 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 8ca1e976de7..089699aaa7e 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 1bbef8f0f9e..d2b3b49eaf5 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 0c8668ee0bc..08000161f14 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 a19d8969b40..9b09c485329 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
--
GitLab