[Bf-blender-cvs] SVN commit: /data/svn/bf-blender [35082] trunk/blender: doxygen: bge scenegraph and videotexture
Nathan Letwory
nathan at letworyinteractive.com
Tue Feb 22 20:30:37 CET 2011
Revision: 35082
http://projects.blender.org/scm/viewvc.php?view=rev&root=bf-blender&revision=35082
Author: jesterking
Date: 2011-02-22 19:30:37 +0000 (Tue, 22 Feb 2011)
Log Message:
-----------
doxygen: bge scenegraph and videotexture
Modified Paths:
--------------
trunk/blender/doc/Doxyfile
trunk/blender/doc/doxygen.main
trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h
trunk/blender/source/gameengine/SceneGraph/SG_BBox.h
trunk/blender/source/gameengine/SceneGraph/SG_Controller.h
trunk/blender/source/gameengine/SceneGraph/SG_DList.h
trunk/blender/source/gameengine/SceneGraph/SG_IObject.h
trunk/blender/source/gameengine/SceneGraph/SG_Node.h
trunk/blender/source/gameengine/SceneGraph/SG_ParentRelation.h
trunk/blender/source/gameengine/SceneGraph/SG_QList.h
trunk/blender/source/gameengine/SceneGraph/SG_Spatial.h
trunk/blender/source/gameengine/SceneGraph/SG_Tree.h
trunk/blender/source/gameengine/VideoTexture/BlendType.h
trunk/blender/source/gameengine/VideoTexture/Common.h
trunk/blender/source/gameengine/VideoTexture/Exception.h
trunk/blender/source/gameengine/VideoTexture/FilterBase.h
trunk/blender/source/gameengine/VideoTexture/FilterBlueScreen.h
trunk/blender/source/gameengine/VideoTexture/FilterColor.h
trunk/blender/source/gameengine/VideoTexture/FilterNormal.h
trunk/blender/source/gameengine/VideoTexture/FilterSource.h
trunk/blender/source/gameengine/VideoTexture/ImageBase.h
trunk/blender/source/gameengine/VideoTexture/ImageBuff.h
trunk/blender/source/gameengine/VideoTexture/ImageMix.h
trunk/blender/source/gameengine/VideoTexture/ImageRender.h
trunk/blender/source/gameengine/VideoTexture/ImageViewport.h
trunk/blender/source/gameengine/VideoTexture/PyTypeList.h
trunk/blender/source/gameengine/VideoTexture/Texture.h
trunk/blender/source/gameengine/VideoTexture/VideoBase.h
trunk/blender/source/gameengine/VideoTexture/VideoFFmpeg.h
Modified: trunk/blender/doc/Doxyfile
===================================================================
--- trunk/blender/doc/Doxyfile 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/doc/Doxyfile 2011-02-22 19:30:37 UTC (rev 35082)
@@ -632,15 +632,7 @@
../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 @@
# 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
Modified: trunk/blender/doc/doxygen.main
===================================================================
--- trunk/blender/doc/doxygen.main 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/doc/doxygen.main 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h
===================================================================
--- trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/Physics/Bullet/CcdPhysicsEnvironment.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -15,6 +15,7 @@
/** \file CcdPhysicsEnvironment.h
* \ingroup physbullet
+ * See also \ref bulletdoc
*/
#ifndef CCDPHYSICSENVIRONMENT
Modified: trunk/blender/source/gameengine/SceneGraph/SG_BBox.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_BBox.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_BBox.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,8 +25,12 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
- * Bounding Box
*/
+
+/** \file SG_BBox.h
+ * \ingroup bgesg
+ * \brief Bounding Box
+ */
#ifndef __SG_BBOX_H__
#define __SG_BBOX_H__
Modified: trunk/blender/source/gameengine/SceneGraph/SG_Controller.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_Controller.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_Controller.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_DList.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_DList.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_DList.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_IObject.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_IObject.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_IObject.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_Node.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_Node.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_Node.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_ParentRelation.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_ParentRelation.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_ParentRelation.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_QList.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_QList.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_QList.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_Spatial.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_Spatial.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_Spatial.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -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
Modified: trunk/blender/source/gameengine/SceneGraph/SG_Tree.h
===================================================================
--- trunk/blender/source/gameengine/SceneGraph/SG_Tree.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/SceneGraph/SG_Tree.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -25,9 +25,12 @@
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
- * Bounding Box
*/
+/** \file SG_Tree.h
+ * \ingroup bgesg
+ */
+
#ifndef __SG_TREE_H__
#define __SG_TREE_H__
Modified: trunk/blender/source/gameengine/VideoTexture/BlendType.h
===================================================================
--- trunk/blender/source/gameengine/VideoTexture/BlendType.h 2011-02-22 19:22:27 UTC (rev 35081)
+++ trunk/blender/source/gameengine/VideoTexture/BlendType.h 2011-02-22 19:30:37 UTC (rev 35082)
@@ -20,6 +20,10 @@
-----------------------------------------------------------------------------
*/
+/** \file BlendType.h
+ * \ingroup bgevideotex
+ */
+
#if !defined BLENDTYPE_H
#define BLENDTYPE_H
Modified: trunk/blender/source/gameengine/VideoTexture/Common.h
===================================================================
--- trunk/blender/source/gameengine/VideoTexture/Common.h 2011-02-22 19:22:27 UTC (rev 35081)
@@ Diff output truncated at 10240 characters. @@
More information about the Bf-blender-cvs
mailing list