Welcome to mirror list, hosted at ThFree Co, Russian Federation.

git.blender.org/blender.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNathan Letwory <nathan@letworyinteractive.com>2011-02-22 13:33:14 +0300
committerNathan Letwory <nathan@letworyinteractive.com>2011-02-22 13:33:14 +0300
commit5138615554bee47a586209c7f4d3830758ff598e (patch)
treed7f8d6409266901db51dd594f762837d427b5b0a /source/gameengine/Expressions
parent7729ecc98f0e9890ff0fc7c3a49a516b8807bafc (diff)
doxygen: entries for blenderroutines, converter, expressions, gamelogic, gameplayer, ketsji
Diffstat (limited to 'source/gameengine/Expressions')
-rw-r--r--source/gameengine/Expressions/BoolValue.h5
-rw-r--r--source/gameengine/Expressions/ConstExpr.h4
-rw-r--r--source/gameengine/Expressions/EXP_C-Api.h7
-rw-r--r--source/gameengine/Expressions/EmptyValue.h5
-rw-r--r--source/gameengine/Expressions/ErrorValue.h4
-rw-r--r--source/gameengine/Expressions/Expression.h4
-rw-r--r--source/gameengine/Expressions/FloatValue.h5
-rw-r--r--source/gameengine/Expressions/IdentifierExpr.h7
-rw-r--r--source/gameengine/Expressions/IfExpr.h5
-rw-r--r--source/gameengine/Expressions/InputParser.h5
-rw-r--r--source/gameengine/Expressions/IntValue.h5
-rw-r--r--source/gameengine/Expressions/KX_HashedPtr.h7
-rw-r--r--source/gameengine/Expressions/KX_Python.h7
-rw-r--r--source/gameengine/Expressions/ListValue.h4
-rw-r--r--source/gameengine/Expressions/Operator1Expr.h4
-rw-r--r--source/gameengine/Expressions/Operator2Expr.h4
-rw-r--r--source/gameengine/Expressions/PyObjectPlus.h6
-rw-r--r--source/gameengine/Expressions/StringValue.h4
-rw-r--r--source/gameengine/Expressions/Value.h57
-rw-r--r--source/gameengine/Expressions/VectorValue.h5
-rw-r--r--source/gameengine/Expressions/VoidValue.h7
21 files changed, 126 insertions, 35 deletions
diff --git a/source/gameengine/Expressions/BoolValue.h b/source/gameengine/Expressions/BoolValue.h
index 8110b9719bf..a88bcf98e77 100644
--- a/source/gameengine/Expressions/BoolValue.h
+++ b/source/gameengine/Expressions/BoolValue.h
@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file BoolValue.h
+ * \ingroup expressions
+ */
+
#if !defined _BOOLVALUE_H
#define _BOOLVALUE_H
diff --git a/source/gameengine/Expressions/ConstExpr.h b/source/gameengine/Expressions/ConstExpr.h
index aef2ddc2467..07278eb03f6 100644
--- a/source/gameengine/Expressions/ConstExpr.h
+++ b/source/gameengine/Expressions/ConstExpr.h
@@ -13,6 +13,10 @@
*
*/
+/** \file ConstExpr.h
+ * \ingroup expressions
+ */
+
#ifndef __CONSTEXPR_H__
#define __CONSTEXPR_H__
diff --git a/source/gameengine/Expressions/EXP_C-Api.h b/source/gameengine/Expressions/EXP_C-Api.h
index 12fdc4945e7..89156033be5 100644
--- a/source/gameengine/Expressions/EXP_C-Api.h
+++ b/source/gameengine/Expressions/EXP_C-Api.h
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
+
+/** \file EXP_C-Api.h
+ * \ingroup expressions
+ */
+
#ifndef __EXPRESSION_INCLUDE
#define __EXPRESSION_INCLUDE
diff --git a/source/gameengine/Expressions/EmptyValue.h b/source/gameengine/Expressions/EmptyValue.h
index f00bc6cfcd7..1b1c1159169 100644
--- a/source/gameengine/Expressions/EmptyValue.h
+++ b/source/gameengine/Expressions/EmptyValue.h
@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file EmptyValue.h
+ * \ingroup expressions
+ */
+
#if !defined _EMPTYVALUE_H
#define _EMPTYVALUE_H
diff --git a/source/gameengine/Expressions/ErrorValue.h b/source/gameengine/Expressions/ErrorValue.h
index 6bd131b762d..7f18e751af9 100644
--- a/source/gameengine/Expressions/ErrorValue.h
+++ b/source/gameengine/Expressions/ErrorValue.h
@@ -13,6 +13,10 @@
*
*/
+/** \file ErrorValue.h
+ * \ingroup expressions
+ */
+
#if !defined _ERRORVALUE_H
#define _ERRORVALUE_H
diff --git a/source/gameengine/Expressions/Expression.h b/source/gameengine/Expressions/Expression.h
index de0c0821727..c285fa118c1 100644
--- a/source/gameengine/Expressions/Expression.h
+++ b/source/gameengine/Expressions/Expression.h
@@ -13,6 +13,10 @@
*
*/
+/** \file Expression.h
+ * \ingroup expressions
+ */
+
#if !defined _EXPRESSION_H
#define _EXPRESSION_H
diff --git a/source/gameengine/Expressions/FloatValue.h b/source/gameengine/Expressions/FloatValue.h
index 83b9ff1db5e..535939e1758 100644
--- a/source/gameengine/Expressions/FloatValue.h
+++ b/source/gameengine/Expressions/FloatValue.h
@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file FloatValue.h
+ * \ingroup expressions
+ */
+
#if !defined _FLOATVALUE_H
#define _FLOATVALUE_H
diff --git a/source/gameengine/Expressions/IdentifierExpr.h b/source/gameengine/Expressions/IdentifierExpr.h
index 0e67b17a9c2..676b1b11607 100644
--- a/source/gameengine/Expressions/IdentifierExpr.h
+++ b/source/gameengine/Expressions/IdentifierExpr.h
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
+
+/** \file IdentifierExpr.h
+ * \ingroup expressions
+ */
+
#ifndef __IDENTIFIER_EXPR
#define __IDENTIFIER_EXPR
diff --git a/source/gameengine/Expressions/IfExpr.h b/source/gameengine/Expressions/IfExpr.h
index b2a953bd36d..5ac8d835afd 100644
--- a/source/gameengine/Expressions/IfExpr.h
+++ b/source/gameengine/Expressions/IfExpr.h
@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file IfExpr.h
+ * \ingroup expressions
+ */
+
#if !defined(AFX_IFEXPR_H__1F691841_C5C7_11D1_A863_0000B4542BD8__INCLUDED_)
#define AFX_IFEXPR_H__1F691841_C5C7_11D1_A863_0000B4542BD8__INCLUDED_
diff --git a/source/gameengine/Expressions/InputParser.h b/source/gameengine/Expressions/InputParser.h
index 4c47677034b..d5a9295ab8b 100644
--- a/source/gameengine/Expressions/InputParser.h
+++ b/source/gameengine/Expressions/InputParser.h
@@ -14,6 +14,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file InputParser.h
+ * \ingroup expressions
+ */
+
#ifndef __INPUTPARSER_H__
#define __INPUTPARSER_H__
diff --git a/source/gameengine/Expressions/IntValue.h b/source/gameengine/Expressions/IntValue.h
index e484c436177..5460f744de3 100644
--- a/source/gameengine/Expressions/IntValue.h
+++ b/source/gameengine/Expressions/IntValue.h
@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file IntValue.h
+ * \ingroup expressions
+ */
+
#if !defined _INTVALUE_H
#define _INTVALUE_H
diff --git a/source/gameengine/Expressions/KX_HashedPtr.h b/source/gameengine/Expressions/KX_HashedPtr.h
index 09332377918..77e581360e7 100644
--- a/source/gameengine/Expressions/KX_HashedPtr.h
+++ b/source/gameengine/Expressions/KX_HashedPtr.h
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
+
+/** \file KX_HashedPtr.h
+ * \ingroup expressions
+ */
+
#ifndef __KX_HASHEDPTR
#define __KX_HASHEDPTR
diff --git a/source/gameengine/Expressions/KX_Python.h b/source/gameengine/Expressions/KX_Python.h
index 234b70770f6..9d295e1910e 100644
--- a/source/gameengine/Expressions/KX_Python.h
+++ b/source/gameengine/Expressions/KX_Python.h
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -26,6 +26,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
+
+/** \file KX_Python.h
+ * \ingroup expressions
+ */
+
#ifndef KX_PYTHON_H
#define KX_PYTHON_H
diff --git a/source/gameengine/Expressions/ListValue.h b/source/gameengine/Expressions/ListValue.h
index ff675dd0e68..c1530d86d8c 100644
--- a/source/gameengine/Expressions/ListValue.h
+++ b/source/gameengine/Expressions/ListValue.h
@@ -13,6 +13,10 @@
*
*/
+/** \file ListValue.h
+ * \ingroup expressions
+ */
+
#if !defined _LISTVALUE_H
#define _LISTVALUE_H
diff --git a/source/gameengine/Expressions/Operator1Expr.h b/source/gameengine/Expressions/Operator1Expr.h
index 62f178fb9f7..c6fce709248 100644
--- a/source/gameengine/Expressions/Operator1Expr.h
+++ b/source/gameengine/Expressions/Operator1Expr.h
@@ -13,6 +13,10 @@
*
*/
+/** \file Operator1Expr.h
+ * \ingroup expressions
+ */
+
#if !defined(AFX_OPERATOR1EXPR_H__A1653901_BF41_11D1_A51C_00A02472FC58__INCLUDED_)
#define AFX_OPERATOR1EXPR_H__A1653901_BF41_11D1_A51C_00A02472FC58__INCLUDED_
diff --git a/source/gameengine/Expressions/Operator2Expr.h b/source/gameengine/Expressions/Operator2Expr.h
index 73ea177f0d0..3b4d604c254 100644
--- a/source/gameengine/Expressions/Operator2Expr.h
+++ b/source/gameengine/Expressions/Operator2Expr.h
@@ -13,6 +13,10 @@
*
*/
+/** \file Operator2Expr.h
+ * \ingroup expressions
+ */
+
#if !defined _OPERATOR2EXPR_H
#define _OPERATOR2EXPR_H
diff --git a/source/gameengine/Expressions/PyObjectPlus.h b/source/gameengine/Expressions/PyObjectPlus.h
index 4890a5edb04..12ae31f6c82 100644
--- a/source/gameengine/Expressions/PyObjectPlus.h
+++ b/source/gameengine/Expressions/PyObjectPlus.h
@@ -1,4 +1,4 @@
-/**
+/*
* $Id$
*
* ***** BEGIN GPL LICENSE BLOCK *****
@@ -27,6 +27,10 @@
* ***** END GPL LICENSE BLOCK *****
*/
+/** \file PyObjectPlus.h
+ * \ingroup expressions
+ */
+
#ifndef _adr_py_lib_h_ // only process once,
#define _adr_py_lib_h_ // even if multiply included
diff --git a/source/gameengine/Expressions/StringValue.h b/source/gameengine/Expressions/StringValue.h
index ef8228141a2..6afe7fa5935 100644
--- a/source/gameengine/Expressions/StringValue.h
+++ b/source/gameengine/Expressions/StringValue.h
@@ -13,6 +13,10 @@
*
*/
+/** \file StringValue.h
+ * \ingroup expressions
+ */
+
#ifndef __STRINGVALUE_H__
#define __STRINGVALUE_H__
diff --git a/source/gameengine/Expressions/Value.h b/source/gameengine/Expressions/Value.h
index b4bb34b0331..ef7edd397b7 100644
--- a/source/gameengine/Expressions/Value.h
+++ b/source/gameengine/Expressions/Value.h
@@ -13,29 +13,14 @@
*
*/
+/** \file Value.h
+ * \ingroup expressions
+ */
+
#if defined(WIN32) && !defined(FREE_WINDOWS)
#pragma warning (disable:4786)
#endif //WIN32
-/////////////////////////////////////////////////////////////////////////////////////
-//// Baseclass CValue
-//// Together with CExpression, CValue and it's derived classes can be used to
-//// parse expressions into a parsetree with error detecting/correcting capabilities
-//// also expandible by a CFactory pluginsystem
-////
-//// Features:
-//// Reference Counting (AddRef() / Release())
-//// Calculations (Calc() / CalcFinal())
-//// Configuration (Configure())
-//// Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL
-//// Property system (SetProperty() / GetProperty() / FindIdentifier())
-//// Replication (GetReplica())
-//// Flags (IsSelected() / IsModified() / SetSelected()...)
-////
-//// Some small editor-specific things added
-//// A helperclass CompressorArchive handles the serialization
-////
-/////////////////////////////////////////////////////////////////////////////////////
#ifndef __VALUE_H__
#define __VALUE_H__
@@ -184,21 +169,35 @@ public:
#endif
};
-//
-// CValue
-//
-// Base class for all editor functionality, flexible object type that allows
-// calculations and uses reference counting for memory management.
-//
-//
-
-
-
#include "PyObjectPlus.h"
#ifdef WITH_PYTHON
#include "object.h"
#endif
+
+/**
+ * Baseclass CValue
+ *
+ * Together with CExpression, CValue and it's derived classes can be used to
+ * parse expressions into a parsetree with error detecting/correcting capabilities
+ * also expandible by a CFactory pluginsystem
+ *
+ * Base class for all editor functionality, flexible object type that allows
+ * calculations and uses reference counting for memory management.
+ *
+ * Features:
+ * - Reference Counting (AddRef() / Release())
+ * - Calculations (Calc() / CalcFinal())
+ * - Configuration (Configure())
+ * - Serialization (EdSerialize() / EdIdSerialize() / EdPtrSerialize() and macro PLUGIN_DECLARE_SERIAL
+ * - Property system (SetProperty() / GetProperty() / FindIdentifier())
+ * - Replication (GetReplica())
+ * - Flags (IsSelected() / IsModified() / SetSelected()...)
+ *
+ * - Some small editor-specific things added
+ * - A helperclass CompressorArchive handles the serialization
+ *
+ */
class CValue : public PyObjectPlus
{
diff --git a/source/gameengine/Expressions/VectorValue.h b/source/gameengine/Expressions/VectorValue.h
index cc4deda2041..94d1ae65ada 100644
--- a/source/gameengine/Expressions/VectorValue.h
+++ b/source/gameengine/Expressions/VectorValue.h
@@ -12,6 +12,11 @@
* purpose. It is provided "as is" without express or implied warranty.
*
*/
+
+/** \file VectorValue.h
+ * \ingroup expressions
+ */
+
#if !defined _VECTORVALUE_H
#define _VECTORVALUE_H
diff --git a/source/gameengine/Expressions/VoidValue.h b/source/gameengine/Expressions/VoidValue.h
index f30f8c1be7c..2e5c056d793 100644
--- a/source/gameengine/Expressions/VoidValue.h
+++ b/source/gameengine/Expressions/VoidValue.h
@@ -1,4 +1,4 @@
-/**
+/*
* VoidValue.h: interface for the CVoidValue class.
* $Id$
*
@@ -27,6 +27,11 @@
*
* ***** END GPL LICENSE BLOCK *****
*/
+
+/** \file VoidValue.h
+ * \ingroup expressions
+ */
+
#ifndef __VOIDVALUE_H__
#define __VOIDVALUE_H__