[Bf-committers] BGE API DOC - volunteers needed to document VideoTexture and Physics Constraints modules

[Dalai Felinto]

Hello everybody.

Blender Game Engine still lacks important documentation. Two modules
are completely undocumented in the API - VideoTexture and
PhysicsConstraints. I would like to see if anyone would like to
volunteer to help documenting them. I started the work, listing all
the functions and putting them in the correct file. The next step is
to go through the methods listed in the file and to write their
description, parameters and return types.

Physics Constraints:
Documentation available at:
- Blender Gamekit 2nd edition: pages 281 to 292 (Ton, Carsteen: could
we have those pages shared as a pdf?)
File: //source/gameengine/PyDoc/PhysicsConstraints.py
http://projects.blender.org/plugins/scmsvn/viewcvs.php/trunk/blender/source/gameengine/PyDoc/PhysicsConstraints.py?revision=25875&root=bf-blender

VideoTexture
Documentation available at:
http://wiki.blender.org/index.php/Dev:Source/GameEngine/2.49/VideoTexture.py
File: //source/gameengine/PyDoc/VideoTexture.py
http://projects.blender.org/plugins/scmsvn/viewcvs.php/trunk/blender/source/gameengine/PyDoc/VideoTexture.py?revision=25875&root=bf-blender

Example of documented module (Rasterizer):
http://www.blender.org/documentation/249PythonDoc/GE/Rasterizer-module.html
File: //source/gameengine/PyDoc/Rasterizer.py
http://projects.blender.org/plugins/scmsvn/viewcvs.php/trunk/blender/source/gameengine/PyDoc/Rasterizer.py?revision=25875&root=bf-blender

Please do not exitate in ask any further questions on that. I hope
someone takes this as a New Year's resolution.

Cheers,
Dalai