From 8fcaa1782ddd9d7fecc2c8a3549c4250aa2ef91d Mon Sep 17 00:00:00 2001 From: Campbell Barton Date: Tue, 14 Oct 2008 22:31:10 +0000 Subject: cleanup epydoc errors --- source/gameengine/PyDoc/KX_ActuatorSensor.py | 1 + source/gameengine/PyDoc/KX_ConstraintActuator.py | 22 +++++++++++----------- source/gameengine/PyDoc/KX_IpoActuator.py | 6 +++--- source/gameengine/PyDoc/Rasterizer.py | 15 ++++++++------- source/gameengine/PyDoc/epy_docgen.sh | 2 +- 5 files changed, 24 insertions(+), 22 deletions(-) (limited to 'source/gameengine/PyDoc') diff --git a/source/gameengine/PyDoc/KX_ActuatorSensor.py b/source/gameengine/PyDoc/KX_ActuatorSensor.py index f9aef86f7f0..cdfbf27576e 100644 --- a/source/gameengine/PyDoc/KX_ActuatorSensor.py +++ b/source/gameengine/PyDoc/KX_ActuatorSensor.py @@ -1,6 +1,7 @@ # $Id$ # Documentation for KX_ActuatorSensor from SCA_IActuator import * +from SCA_ISensor import * class KX_ActuatorSensor(SCA_ISensor): """ diff --git a/source/gameengine/PyDoc/KX_ConstraintActuator.py b/source/gameengine/PyDoc/KX_ConstraintActuator.py index b1c6f3c0f4e..7c7ad5aa0fa 100644 --- a/source/gameengine/PyDoc/KX_ConstraintActuator.py +++ b/source/gameengine/PyDoc/KX_ConstraintActuator.py @@ -58,11 +58,11 @@ class KX_ConstraintActuator(SCA_IActuator): See module L{GameLogic} for valid constraint types. - @param limit: Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, - Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ - Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, - KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ, - Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ + @param limit: + Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ + Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY or KX_CONSTRAINTACT_ROTZ + Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ + Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ """ def getLimit(): """ @@ -70,11 +70,11 @@ class KX_ConstraintActuator(SCA_IActuator): See module L{GameLogic} for valid constraints. - @return: Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, - Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ, - Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, - KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ, - Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ + @return: + Position constraints: KX_CONSTRAINTACT_LOCX, KX_CONSTRAINTACT_LOCY, KX_CONSTRAINTACT_LOCZ, + Rotation constraints: KX_CONSTRAINTACT_ROTX, KX_CONSTRAINTACT_ROTY, KX_CONSTRAINTACT_ROTZ, + Distance contraints: KX_ACT_CONSTRAINT_DIRPX, KX_ACT_CONSTRAINT_DIRPY, KX_ACT_CONSTRAINT_DIRPZ, KX_ACT_CONSTRAINT_DIRNX, KX_ACT_CONSTRAINT_DIRNY, KX_ACT_CONSTRAINT_DIRNZ, + Orientation constraints: KX_ACT_CONSTRAINT_ORIX, KX_ACT_CONSTRAINT_ORIY, KX_ACT_CONSTRAINT_ORIZ """ def setRotDamp(duration): """ @@ -107,7 +107,7 @@ class KX_ConstraintActuator(SCA_IActuator): @type option: integer @param option: Binary combination of the following values: - 64 : Activate alignment to surface + 64 : Activate alignment to surface 128 : Detect material rather than property 256 : No deactivation if ray does not hit target 512 : Activate distance control diff --git a/source/gameengine/PyDoc/KX_IpoActuator.py b/source/gameengine/PyDoc/KX_IpoActuator.py index 1cdab829385..e2fe3b289e3 100644 --- a/source/gameengine/PyDoc/KX_IpoActuator.py +++ b/source/gameengine/PyDoc/KX_IpoActuator.py @@ -6,7 +6,7 @@ class KX_IpoActuator(SCA_IActuator): """ IPO actuator activates an animation. """ - def set(mode, startframe, endframe, mode): + def set(mode, startframe, endframe, force): """ Sets the properties of the actuator. @@ -16,8 +16,8 @@ class KX_IpoActuator(SCA_IActuator): @type startframe: integer @param endframe: last frame to use @type endframe: integer - @param mode: special mode - @type mode: integer (0=normal, 1=interpret location as force, 2=additive) + @param force: special mode + @type force: integer (0=normal, 1=interpret location as force, 2=additive) """ def setProperty(property): """ diff --git a/source/gameengine/PyDoc/Rasterizer.py b/source/gameengine/PyDoc/Rasterizer.py index cdda87fcb49..6a67cdcc71b 100644 --- a/source/gameengine/PyDoc/Rasterizer.py +++ b/source/gameengine/PyDoc/Rasterizer.py @@ -40,8 +40,8 @@ Example Uses an L{SCA_MouseSensor}, and two L{KX_ObjectActuator}s to implement M @group Material Types: KX_TEXFACE_MATERIAL, KX_BLENDER_MULTITEX_MATERIAL, KX_BLENDER_GLSL_MATERIAL @var KX_TEXFACE_MATERIAL: Materials as defined by the texture face settings. @var KX_BLENDER_MULTITEX_MATERIAL: Materials approximating blender materials with multitexturing. -@var KX_BLENDER_BLENDER_MATERIAL: Materials approximating blender materials with GLSL. - +@var KX_BLENDER_GLSL_MATERIAL: Materials approximating blender materials with GLSL. + """ def getWindowWidth(): @@ -181,14 +181,15 @@ def getGLSLMaterialSetting(setting, enable): @type setting: string (lights, shaders, shadows, ramps, nodes, extra_textures) @rtype: boolean """ -def drawLine(from,to,color): + +def drawLine(fromVec,toVec,color): """ Draw a line in the 3D scene. - @param from: the origin of the line - @type from: list [x, y, z] - @param to: the end of the line - @type to: list [x, y, z] + @param fromVec: the origin of the line + @type fromVec: list [x, y, z] + @param toVec: the end of the line + @type toVec: list [x, y, z] @param color: the color of the line @type color: list [r, g, b] """ diff --git a/source/gameengine/PyDoc/epy_docgen.sh b/source/gameengine/PyDoc/epy_docgen.sh index 7fb5e49c996..b243101ddcb 100644 --- a/source/gameengine/PyDoc/epy_docgen.sh +++ b/source/gameengine/PyDoc/epy_docgen.sh @@ -7,5 +7,5 @@ # set posix locale so regex works properly for [A-Z]*.py LC_ALL=POSIX -epydoc -v -o BPY_GE --url "http://www.blender.org" --top GameLogic \ +epydoc --debug -v -o BPY_GE --url "http://www.blender.org" --top GameLogic \ --name "Blender GameEngine" --no-private --no-frames *.py -- cgit v1.2.3