blender/source/gameengine/PyDoc/epy_docgen.sh

# epy_docgen.sh
# generates blender python doc using epydoc
# requires epydoc in your PATH.
# run from the doc directory containing the .py files
# usage:  sh epy_docgen.sh

# set posix locale so regex works properly for [A-Z]*.py
LC_ALL=POSIX

epydoc --debug -v  -o BPY_GE --url "http://www.blender.org" --top GameLogic \
 --name "Blender GameEngine" --no-private --no-sourcecode --inheritance=included *.py
replacing epydoc generation script with one copied from bpy docs 2008-05-20 05:55:12 +00:00			`# epy_docgen.sh`
			`# generates blender python doc using epydoc`
			`# requires epydoc in your PATH.`
			`# run from the doc directory containing the .py files`
			`# usage: sh epy_docgen.sh`

			`# set posix locale so regex works properly for [A-Z]*.py`
			`LC_ALL=POSIX`

cleanup epydoc errors 2008-10-14 22:31:10 +00:00			`epydoc --debug -v -o BPY_GE --url "http://www.blender.org" --top GameLogic \`
BGE Doc updates thanks to Roelf de Kock --- Notes from Roelf, maybe some other BGE devs could help resolve these Here is what I have so far. I've left "TODO's" were there needs to be some more comments. The following things also need to be resolved: -KX_VehicleWrapper.getWheelOrientationQuaternion looks like it should return a quaternion but if I look at the code it looks like it returns a rotation matrix. -I still need to find out what exactly KX_VehicleWrapper.getWheelRotation is. I've got the return type but I would like to add some explanation for what it actualy means (and units if any). -BL_Shader.setNumberOfPasses ignores the parameter but from the comment in the code it looks like the parameter that is being set (it is harcoded to be =1) in setNumberOfPasses is not used. So I'm not sure if this method should be documented at all. 2009-05-11 21:35:38 +00:00			`--name "Blender GameEngine" --no-private --no-sourcecode --inheritance=included *.py`