[Bf-blender-cvs] [c015676] mathutils_bvhtree: Nicer doc strings for BVHTree subclasses.
Lukas Tönne
noreply at git.blender.org
Sat Jan 3 11:09:26 CET 2015
Commit: c015676e6cdedbe29ba56ea555a1bdaaa80c19d6
Author: Lukas Tönne
Date: Mon Dec 29 09:14:34 2014 +0100
Branches: mathutils_bvhtree
https://developer.blender.org/rBc015676e6cdedbe29ba56ea555a1bdaaa80c19d6
Nicer doc strings for BVHTree subclasses.
===================================================================
M source/blender/python/mathutils/mathutils_bvhtree.c
===================================================================
diff --git a/source/blender/python/mathutils/mathutils_bvhtree.c b/source/blender/python/mathutils/mathutils_bvhtree.c
index a9d7f74..dd6de06 100644
--- a/source/blender/python/mathutils/mathutils_bvhtree.c
+++ b/source/blender/python/mathutils/mathutils_bvhtree.c
@@ -383,7 +383,14 @@ static PyMethodDef PyDerivedMeshBVHTree_methods[] = {
};
PyDoc_STRVAR(py_DerivedMeshBVHTree_doc,
-"BVH tree based on :class:`Object` mesh data.\n"
+".. method:: DerivedMeshBVHTree(object, type='POLYS')\n"
+"\n"
+" BVH tree based on :class:`Object` mesh data.\n"
+"\n"
+" :arg object: Mesh object.\n"
+" :type object: :class:`Object`\n"
+" :art type: Maximum search distance\n"
+" :type type: :string in ['POLYS', 'FACES', 'VERTS', 'EDGES']\n"
);
PyTypeObject PyDerivedMeshBVHTree_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
@@ -590,7 +597,12 @@ static PyMethodDef PyBMeshBVHTree_methods[] = {
};
PyDoc_STRVAR(py_BMeshBVHTree_doc,
-"BVH tree based on :class:`BMesh` data.\n"
+".. method:: BMeshBVHTree(bm)\n"
+"\n"
+" BVH tree based on :class:`BMesh` data.\n"
+"\n"
+" :arg bm: BMesh data.\n"
+" :type bm: :class:`BMesh`\n"
);
PyTypeObject PyBMeshBVHTree_Type = {
PyVarObject_HEAD_INIT(NULL, 0)
More information about the Bf-blender-cvs
mailing list